Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Account API key passed in the Authorization header

Path Parameters

endpointID
string
required

Endpoint UUID.

Query Parameters

account_id
string

Target account UUID. Required for staff; ignored for customer keys.

Body

application/json
description
string

Omit to leave unchanged.

is_enabled
boolean

Pause or resume delivery to this endpoint. Omit to leave unchanged.

Example:

false

Response

OK

created_at
string<date-time>
required

When the endpoint was registered. Only events detected after this are ever pushed to it.

id
string
required

Endpoint UUID. Use it to update, delete, or filter deliveries.

is_enabled
boolean
required

When false, nothing is pushed here. Events are unaffected and stay readable from the feed.

updated_at
string<date-time>
required

When the endpoint was last changed.

url
string
required

HTTPS destination events are POSTed to.

Example:

"https://hooks.example.com/tamtam"

description
string

Free-text label, so several endpoints can be told apart.