Transactional
Contacts
Lists
Custom Events
Broadcasts
Templates
Webhooks
- POSTCreate a webhook subscription
- GETList webhook subscriptions
- GETGet a webhook subscription
- POSTUpdate a webhook subscription
- POSTDelete a webhook subscription
- POSTToggle webhook subscription enabled state
- POSTRegenerate webhook secret
- GETGet webhook delivery history
- POSTSend a test webhook
- GETList available event types
curl --request POST \
--url https://{notifuseDomain}/subscribe \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"contact": {
"email": "[email protected]",
"email_hmac": "a1b2c3d4e5f6...",
"external_id": "user_12345",
"timezone": "America/New_York",
"language": "en-US",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"phone": "+15551234567",
"address_line_1": "123 Main St",
"address_line_2": "Apt 4B",
"country": "US",
"postcode": "10001",
"state": "NY",
"job_title": "Software Engineer",
"custom_string_1": "Premium tier",
"custom_string_2": "<string>",
"custom_string_3": "<string>",
"custom_string_4": "<string>",
"custom_string_5": "<string>",
"custom_number_1": 42,
"custom_number_2": 123,
"custom_number_3": 123,
"custom_number_4": 123,
"custom_number_5": 123,
"custom_datetime_1": "2023-06-01T09:00:00Z",
"custom_datetime_2": "2023-11-07T05:31:56Z",
"custom_datetime_3": "2023-11-07T05:31:56Z",
"custom_datetime_4": "2023-11-07T05:31:56Z",
"custom_datetime_5": "2023-11-07T05:31:56Z",
"custom_json_1": {
"preferences": {
"theme": "dark",
"notifications": true
}
},
"custom_json_2": {},
"custom_json_3": {},
"custom_json_4": {},
"custom_json_5": {}
},
"list_ids": [
"newsletter",
"product_updates"
]
}
'{
"success": true
}Subscribe to email lists
Subscribe a contact to one or more email lists. This is a public endpoint that doesn’t require authentication.
Important: For unauthenticated requests, only public lists can be subscribed to. To subscribe to private lists, you can either:
- Provide a valid
email_hmacin the contact object (used by the notification center for re-subscribing after unsubscribing) - Use the authenticated
/api/lists.subscribeendpoint with a bearer token
If the list has double opt-in enabled, a confirmation email will be sent.
curl --request POST \
--url https://{notifuseDomain}/subscribe \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"contact": {
"email": "[email protected]",
"email_hmac": "a1b2c3d4e5f6...",
"external_id": "user_12345",
"timezone": "America/New_York",
"language": "en-US",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"phone": "+15551234567",
"address_line_1": "123 Main St",
"address_line_2": "Apt 4B",
"country": "US",
"postcode": "10001",
"state": "NY",
"job_title": "Software Engineer",
"custom_string_1": "Premium tier",
"custom_string_2": "<string>",
"custom_string_3": "<string>",
"custom_string_4": "<string>",
"custom_string_5": "<string>",
"custom_number_1": 42,
"custom_number_2": 123,
"custom_number_3": 123,
"custom_number_4": 123,
"custom_number_5": 123,
"custom_datetime_1": "2023-06-01T09:00:00Z",
"custom_datetime_2": "2023-11-07T05:31:56Z",
"custom_datetime_3": "2023-11-07T05:31:56Z",
"custom_datetime_4": "2023-11-07T05:31:56Z",
"custom_datetime_5": "2023-11-07T05:31:56Z",
"custom_json_1": {
"preferences": {
"theme": "dark",
"notifications": true
}
},
"custom_json_2": {},
"custom_json_3": {},
"custom_json_4": {},
"custom_json_5": {}
},
"list_ids": [
"newsletter",
"product_updates"
]
}
'{
"success": true
}Body
The ID of the workspace
"ws_1234567890"
Show child attributes
Show child attributes
Email address of the contact
HMAC of the email for authenticated subscription (optional)
"a1b2c3d4e5f6..."
External identifier for the contact
"user_12345"
Timezone of the contact
"America/New_York"
Preferred language of the contact
"en-US"
First name of the contact
"John"
Last name of the contact
"Doe"
Full name of the contact (for systems that don't have separate first/last names)
"John Doe"
Phone number of the contact
"+15551234567"
First line of address
"123 Main St"
Second line of address
"Apt 4B"
Country of the contact
"US"
Postal code
"10001"
State or province
"NY"
Job title of the contact
"Software Engineer"
Custom string field 1
"Premium tier"
Custom string field 2
Custom string field 3
Custom string field 4
Custom string field 5
Custom number field 1
42
Custom number field 2
Custom number field 3
Custom number field 4
Custom number field 5
Custom datetime field 1
"2023-06-01T09:00:00Z"
Custom datetime field 2
Custom datetime field 3
Custom datetime field 4
Custom datetime field 5
Custom JSON field 1
{
"preferences": { "theme": "dark", "notifications": true }
}Custom JSON field 2
Custom JSON field 3
Custom JSON field 4
Custom JSON field 5
Array of list IDs to subscribe the contact to
1["newsletter", "product_updates"]Response
Subscription successful
Whether the subscription was successful
true