Update a webhook

Update an existing webhook's configuration.

Updatable Fields:

  • name - Change the webhook name
  • url - Change the delivery URL (must be HTTPS)
  • status - Change webhook status (active, disabled)
  • events - Update subscribed events

Status Management:

  • active - Webhook is enabled and will receive deliveries
  • disabled - Webhook is disabled and will not receive deliveries. Also set automatically when your endpoint returns 406 or 410
  • failed - Set automatically after repeated delivery failures (see "Handling Webhook Failures" in the API overview)

Setting status back to active re-enables a disabled or failed webhook. It does not reset retry_count;
a successful delivery does, so send a test delivery after re-enabling.

Note: You cannot update the system identifier or secret key through the Partner API. To rotate the
secret key, create a new webhook and delete the old one.

Example:

{
  "webhook": {
    "status": "disabled"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Webhook ID

Query Params
string

Optional. When supplied, the webhook must belong to this system or the request is rejected with 403.

Body Params
string

Webhook name

uri

HTTPS URL

string
enum

Webhook status

Allowed:
events
array of strings

Array of event types

events
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json