Endpoints and the events they get.

Authentication

Bearer token (content:read): A workspace API key: ud_live_…

Parameters

NameInTypeRequiredDescription
bot_idquerystringOnly for a key that covers several bots (see GET /bots). Or send the Usedocs-Bot header.

Responses

StatusDescription
200Endpoints.
400The request is missing something or has a bad value.
401No API key, or the key is revoked.
403A read key on a write, or a key for another bot.
404Not found.
429Rate limited: 120 requests a minute per key, 30 tasks an hour. See Retry-After.

Response fields

FieldTypeDescription
resultsWebhookEndpoint[]
has_moreboolean
next_cursor`stringnull`

results[]: WebhookEndpoint

FieldTypeDescription
idstring
urlstring
eventsstring[]
enabledboolean
created_atstring
secret_hintstring
secretstringOnly when created or rotated.