List endpoints

GEThttps://api.checkslip.com/api/webhooks/endpoints

API key

Lists every endpoint of the account with its url, the event_types it receives, enabled, and the last 4 characters of the signing secret in secret_hint. A disabled endpoint carries the reason in disabled_reason: MANUAL (you turned it off), GONE (your system answered 410) or FAILING (every send failed for 5 days in a row). A disabled endpoint stores no new messages. Use next_cursor for the next page. Needs an API key with webhook:read.

Parameters

FieldInTypeRequired
traceparentheaderstringno
limitqueryintegerno
cursorquerystringno

Responses

200 application/json

FieldTypeRequired
itemsEndpoint[]yes
items[].idstringyes
items[].urlstring (uri)yes
items[].descriptionstring | nullyes
items[].event_typesslip.checked | webhook.test[]yes
items[].enabledbooleanyes
items[].disabled_reasonMANUAL | GONE | FAILING | nullyes
items[].secret_hintstringyes
items[].previous_secret_expires_atstring (date-time) | nullno
items[].created_atstring (date-time)yes
items[].updated_atstring (date-time)yes
next_cursorstring | nullyes

Possible errors

400401403

An error as Problem Details. All codes are listed at Error codes