Webhooks

Update a webhook

Update an endpoint's url, event_types, and/or enabled. Re-enabling a disabled endpoint clears its failure streak. Send at least one field.

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.sonovault.now
  • URL: https://api.sonovault.now/v1/webhooks/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Webhook id.

Response

Successful response

idstring required

Webhook ID (UUID).

urlstring required

Your HTTPS endpoint, where events are POSTed.

descriptionstring nullable required

Your label for the endpoint. null when you did not set one.

event_typesstring[] required

Which events this endpoint receives.

enabledboolean required

false once you disable it, or after sustained delivery failures auto-disable it.

secretstring

The signing secret for Sonovault-Signature. Returned only by POST /v1/webhooks, once. Store it then; it is never shown again.

created_atstring required

When the endpoint was registered, ISO-8601 UTC.

last_delivery_atstring nullable required

Last delivery attempt, ISO-8601 UTC. null before the first one.

Changes

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