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
- Example: ws_1234567890
Human-readable name for the subscription
- Minimum length: 1
- Maximum length: 255
- Example: Production Webhook
The HTTPS URL to receive webhook events
- Example: https://api.example.com/webhooks/notifuse
List of event types to subscribe to
Optional filters for custom_event.* event types
Show 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 child attributes
Unique identifier for the subscription
- Example: whsub_a1b2c3d4e5f6
Human-readable name for the subscription
- Example: Production Webhook
The HTTPS URL to receive webhook events
- Example: https://api.example.com/webhooks/notifuse
Secret key for signing webhook payloads (Standard Webhooks spec)
- Example: whsec_a1b2c3d4e5f6g7h8i9j0
Settings for webhook subscription
Show child attributes
List of event types this subscription is subscribed to
Optional filters for custom_event.* event types
Show 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 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
- Example: true
Timestamp of the last delivery attempt
- Example: 2024-01-15T10:30:00Z
When the subscription was created
- Example: 2024-01-01T00:00:00Z
When the subscription was last updated
- Example: 2024-01-15T10:30:00Z
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