GET
/
webhook-events
curl --request GET \
  --url https://stoplight.io/mocks/replyteam/reply/765516802/webhook-events
[
  {
    "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
  }
]

Query Parameters

​
subscriptionId
string

Filter events by webhook subscription ID

​
type
string

Filter events by event type

​
limit
integer
default:50

Maximum number of events to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of events to skip for pagination

Required range: x >= 0

Response

200 - application/json

Webhook events retrieved successfully

The response is of type object[].