https://demo.notifuse.com/api/webhookSubscriptions.create Creates a new webhook subscription to receive HTTP callbacks when specified events occur in the workspace.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your API key.
Body application/json
The ID of the workspace
Human-readable name for the subscription
The HTTPS URL to receive webhook events
List of event types to subscribe to
Optional filters for custom_event.* event types
Show 2 child attributes Hide 2 child attributes
Filter by goal type (e.g., purchase, subscription, lead)
Filter by event name (e.g., orders/fulfilled, payment.succeeded)
Narrow the list.* events to these lists. Omit it, or send an empty array, to receive an event for every list in the workspace.
Narrow the segment.* events to these segments. Omit it, or send an empty array, to receive an event for every segment in the workspace.
Response
201 Webhook subscription created successfully object
A webhook subscription that receives HTTP callbacks when events occur
Show 13 child attributes Hide 13 child attributes
Unique identifier for the subscription
Human-readable name for the subscription
The HTTPS URL to receive webhook events
Secret key for signing webhook payloads (Standard Webhooks spec)
Settings for webhook subscription
Show 4 child attributes Hide 4 child attributes
List of event types this subscription is subscribed to
Optional filters for custom_event.* event types
Show 2 child attributes Hide 2 child attributes
Filter by goal type (e.g., purchase, subscription, lead)
Filter by event name (e.g., orders/fulfilled, payment.succeeded)
Lists the list.* events are narrowed to. Absent or empty means every list.
Segments the segment.* events are narrowed to. Absent or empty means every segment.
List of event types this subscription is subscribed to (flattened from settings for convenience)
Optional filters for custom_event.* event types (flattened from settings for convenience)
Show 2 child attributes Hide 2 child attributes
Filter by goal type (e.g., purchase, subscription, lead)
Filter by event name (e.g., orders/fulfilled, payment.succeeded)
Lists the list.* events are narrowed to (flattened from settings for convenience). Absent or empty means every list.
Segments the segment.* events are narrowed to (flattened from settings for convenience). Absent or empty means every segment.
Whether the subscription is currently active
Timestamp of the last delivery attempt
When the subscription was created
When the subscription was last updated
400 Bad request - validation failed object
Error message
401 Unauthorized - invalid or missing authentication token object
Error message
500 Internal server error object
Error message