Update an endpoint

PATCHhttps://api.checkslip.com/api/webhooks/endpoints/{endpoint_id}

API key

Send only the fields to change (url, description, event_types, enabled) as a JSON Merge Patch (Content-Type: application/merge-patch+json). A new url is checked again as on create, and the account owner gets an email. Set enabled to false to stop sending and true to resume. While it is off, new messages are not stored at all, so turning it back on cannot recover them; the time-range resend only covers deliveries that were sent and failed (FAILED). Needs an API key with webhook:manage.

Parameters

FieldInTypeRequired
endpoint_idpathstringyes
traceparentheaderstringno

Request body

application/merge-patch+json

FieldTypeRequired
urlstring (uri)no
descriptionstring | nullno
event_typesslip.checked | webhook.test[]no
enabledbooleanno

Responses

200 application/json

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

Possible errors

400401403404422

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