Introduction
API Documentation
- Sequences
- Sequence Actions
- Sequence Steps
- Sequence Steps Actions
- Sequence Contacts
- Contacts
- Contacts Actions
- Schedules
- Lists
- Tasks
- Templates
- Black List
- Email Accounts
- Statistics
- Reports
- Branded Links
- Webhooks
- Webhook Actions
- Webhook Events
- Webhooks Management
Schemas
Webhooks
Create a webhook subscription
Creates a new webhook subscription
POST
/
webhooks
Create a webhook subscription
Copy
curl --request POST \
--url https://stoplight.io/mocks/replyteam/reply/765516802/webhooks \
--header 'Content-Type: application/json' \
--data '{
"targetUrl": "<string>",
"eventTypes": [
"<string>"
],
"secret": "<string>",
"subscriptionLevel": "sequence",
"sequenceIds": [
123
],
"teamIds": [
123
],
"accountId": 123,
"organizationId": 123
}'
Copy
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"targetUrl": "https://api.example.com/webhook/reply",
"eventTypes": [
"email_replied",
"email_sent"
],
"isActive": true,
"secret": "hmac-secret-key",
"attempt": 0,
"createdAt": "2024-03-08T12:00:00Z",
"updatedAt": "2024-03-08T12:00:00Z",
"subscriptionLevel": "account",
"accountId": 12345
}
Body
application/json
Response
201 - application/json
Webhook subscription created successfully
The response is of type object
.
Create a webhook subscription
Copy
curl --request POST \
--url https://stoplight.io/mocks/replyteam/reply/765516802/webhooks \
--header 'Content-Type: application/json' \
--data '{
"targetUrl": "<string>",
"eventTypes": [
"<string>"
],
"secret": "<string>",
"subscriptionLevel": "sequence",
"sequenceIds": [
123
],
"teamIds": [
123
],
"accountId": 123,
"organizationId": 123
}'
Copy
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"targetUrl": "https://api.example.com/webhook/reply",
"eventTypes": [
"email_replied",
"email_sent"
],
"isActive": true,
"secret": "hmac-secret-key",
"attempt": 0,
"createdAt": "2024-03-08T12:00:00Z",
"updatedAt": "2024-03-08T12:00:00Z",
"subscriptionLevel": "account",
"accountId": 12345
}
Assistant
Responses are generated using AI and may contain mistakes.