Update a webhook endpoint

Change an endpoint's name, URL, or whether it is enabled.

Use this endpoint to change a webhook endpoint's name, url and enabled setting. It replaces all three, so send all three: a missing enabled means true.

To stop Everee sending events to an endpoint, set enabled to false; set it back to true to resume. The signing key doesn't change, and stays masked in the response.

The URL rules are the same as when creating an endpoint.

Errors

StatusMeaning
400The URL points at a non-public host, or has credentials or a fragment.
401The API key is missing, malformed or expired.
404No active endpoint with this ID belongs to your company.
409Another of your endpoints already uses this URL.
422name or url is missing or too long, or url isn't an https URL.
📘

Part of the Webhook Endpoints API. Authenticate with your company API key, as for every company endpoint: see Authentication & API tokens.

Path Params
integer
required

The endpoint's ID.

Body Params
string
required

A label for the endpoint. Up to 255 characters.

string
required

The https URL to deliver events to. It must point at a public internet host, without credentials or a fragment, and can't already be used by another of your endpoints. Up to 2048 characters.

boolean

Whether Everee sends events to this endpoint. Defaults to true.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json