Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

API token for authentication

Body

application/json
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

name
string
required

Human-readable name for the subscription

Required string length: 1 - 255
Example:

"Production Webhook"

url
string<uri>
required

The HTTPS URL to receive webhook events

Example:

"https://api.example.com/webhooks/notifuse"

event_types
string[]
required

List of event types to subscribe to

Minimum array length: 1
Example:
custom_event_filters
object | null

Optional filters for custom_event.* event types

Response

Webhook subscription created successfully

subscription
object

A webhook subscription that receives HTTP callbacks when events occur