Webhooks

Update a webhook

Updates one or more endpoint settings. Omitted fields are unchanged. This endpoint requires a read-write API key.

put/v1/webhooks/{webhookId}

Request

  • Base URL: https://api.postzen.dev
  • URL: https://api.postzen.dev/v1/webhooks/{webhookId}
  • Auth: HTTP bearer

Request body

namestring
urlstring uri
eventsWebhookEvent[]
profileAccess'all_profiles' | 'selected_profiles'
profileIdsstring[]

Replacement profile selection. Must be non-empty for selected_profiles and empty for all_profiles.

secretstring nullable

Omit to keep the stored secret, send a non-empty string to replace it, or send null to remove it.

isActiveboolean

Enable or disable delivery. Re-enabling resets the consecutive exhausted-event count.

Response

Webhook updated.

messagestring required

Changes

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