Webhooks

Update a webhook

Updates a webhook's name, URL, subscribed events, channels, custom headers, mailbox scope, or status and returns the updated endpoint. A change to mailboxIds or namespaceId is checked as the endpoint will stand afterward: every mailbox must belong to the namespace when both are set.

patch/v1/webhooks/{id}

Request

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

Path parameters

idstring required

Request body

namestring nullable
urlstring nullable
eventTypesstring[] nullable
channelsstring[] nullable
mailboxIdsMailboxId[] nullable
namespaceIdstring
headersobject nullable
status'active' | 'disabled' nullable

Response

WebhookEndpoint

idstring required
namestring required
urlstring required
eventTypesstring[] required
channelsstring[] nullable required
mailboxIdsMailboxId[] nullable required
namespaceIdstring required
status'active' | 'disabled' required
hasCustomHeadersboolean required
failureStartedAtstring nullable required
lastSucceededAtstring nullable required
createdAtstring required
updatedAtstring required

Changes

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