List webhook endpoints

Your endpoints.

GET/v1/webhooks

Details

Signing secrets are never listed: one is returned once, by the POST that creates the endpoint. Scope: webhooks.

Responses

200Page of WebhookEndpoint
Endpoints
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

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

idstring
Example: we_a1B2c3D4e5F6.
objectwebhook_endpoint
urlstring (uri)
events* or array of string
numbersarray of string
The number filter: only events about these numbers. Empty: every number.
activeboolean
modetest, live
Which events it receives: the mode of the key that created it (or chosen in the console). A key lists and changes only its own mode's endpoints.
descriptionstring
Nullable.
created_atstring (date-time)

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

const res = await fetch('https://api.jointextkit.com/v1/webhooks', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "we_a1B2c3D4e5F6",
      "object": "webhook_endpoint",
      "mode": "test"
    }
  ],
  "has_more": true,
  "next_cursor": null
}