Create webhook

Create a new webhook endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Create a new webhook endpoint to receive event notifications. Specify the URL and the event types to subscribe to.

Example: Create a webhook pointing to your server's /pelcro-events endpoint to receive subscription_created and subscription_canceled events.


Important Behaviors

  • Max 10 limit: Returns 400 if the account already has 10 webhooks.
  • Webhook secret: A unique secret is returned in the response only on creation. Store it securely — it is not returned on subsequent GET requests. Use it to verify webhook signatures.
Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
required

The webhook endpoint URL. Must be unique per account. Must return HTTP 200 when called via POST.

string

A description of what this webhook is for. Max 200 characters.

boolean
required

Set to true to receive all event types. If false, events_enabled is required.

events_enabled
array of strings

Array of event names to subscribe to. Required when all_events_enabled is false. No duplicates allowed.

events_enabled
Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json