Webhooks

Create a webhook

Creates an outbound webhook endpoint. A user may have up to 25 endpoints. This endpoint requires a read-write API key.

post/v1/webhooks

Request

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

Request body

namestring required
urlstring uri required

Public HTTPS endpoint URL.

eventsWebhookEvent[] required
profileAccess'all_profiles' | 'selected_profiles' required

all_profiles receives events for every profile. selected_profiles requires profileIds.

profileIdsstring[]

Required for selected_profiles and omitted or empty for all_profiles.

secretstring nullable

Optional HMAC signing secret. Omit or send null to create an unsigned endpoint.

isActiveboolean

Response

Webhook created.

messagestring required

Changes

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