TextKitDocs

Send a test event to a webhook endpoint

Sends a signed test.ping event now and returns what the endpoint answered.

POST/v1/webhooks/{id}/test

Path Parameters

  • idstringrequired

    Example: we_a1B2c3D4e5F6.

Details

Test pings are not stored as events (they cannot be replayed) but the attempt shows in the delivery log. Scope: webhooks:write.

Responses

  • 200JSON object

    What the endpoint answered

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectwebhook_test
  • endpoint_idstring
  • okboolean
  • status_codeinteger

    Nullable.

  • errortimeout, unreachable, blocked

    Nullable.

  • latency_msinteger
  • response_bodystring

    First 2 KB of the response. Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded