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
Webhook Events
Get webhook event by Id
Returns a specific webhook event by Id
GET
/
webhook-events
/
{eventId}
Copy
curl --request GET \
--url https://stoplight.io/mocks/replyteam/reply/765516802/webhook-events/{eventId}
Copy
{
"event": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "email_replied",
"timestamp": "2024-03-08T12:00:00Z"
},
"subscription": {
"id": "550e8400-e29b-41d4-a716-446655440001",
"workspaceId": "78f2b6"
},
"payload": {
"contact": {
"id": 12345,
"email": "john@example.com",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"title": "CEO",
"company": "Example Corp"
},
"sequence": {
"id": 67890,
"stepNumber": 1
},
"customFields": {
"CustomField1": "Value1",
"CustomField2": "Value2"
},
"data": {
"replyMessageId": "message-id-123",
"replyDate": "2024-03-08T12:00:00Z",
"sentEmailId": 11111,
"emailAccountId": 22222
}
},
"attempt": 1
}
Path Parameters
Event Id
Response
200 - application/json
Webhook event retrieved successfully
The response is of type object
.
Copy
curl --request GET \
--url https://stoplight.io/mocks/replyteam/reply/765516802/webhook-events/{eventId}
Copy
{
"event": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "email_replied",
"timestamp": "2024-03-08T12:00:00Z"
},
"subscription": {
"id": "550e8400-e29b-41d4-a716-446655440001",
"workspaceId": "78f2b6"
},
"payload": {
"contact": {
"id": 12345,
"email": "john@example.com",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"title": "CEO",
"company": "Example Corp"
},
"sequence": {
"id": 67890,
"stepNumber": 1
},
"customFields": {
"CustomField1": "Value1",
"CustomField2": "Value2"
},
"data": {
"replyMessageId": "message-id-123",
"replyDate": "2024-03-08T12:00:00Z",
"sentEmailId": 11111,
"emailAccountId": 22222
}
},
"attempt": 1
}
Assistant
Responses are generated using AI and may contain mistakes.