Webhooks

Update a webhook endpoint

Update a webhook endpoint's url, subscribed events, name, and/or status (use status to pause and re-enable deliveries without deleting the endpoint). The signing secret is never changed by an update. Verify your changes with Send a test event. Requires the webhooks:manage capability.

patch/webhooks/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/webhooks/{id}
  • Auth: HTTP bearer

Request body

urlstring
eventsstring[]
namestring
status'enabled' | 'disabled'

Response

The updated endpoint.

object'webhook' required
idstring required
namestring required
urlstring required
eventsstring[] required
status'enabled' | 'disabled' | 'suspended' required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.