List webhook events

curl --request GET \
  --url https://api.reply.io/v3/webhook-events \
  --header 'X-API-Key: <api-key>'

[
  {
    "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": "[email protected]",
        "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
  }
]

GET

webhook-events

List webhook events

curl --request GET \
  --url https://api.reply.io/v3/webhook-events \
  --header 'X-API-Key: <api-key>'

[
  {
    "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": "[email protected]",
        "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
  }
]

Authorizations

X-API-Key

string

header

required

API key passed in the X-API-Key header

Query Parameters

subscriptionId

string<uuid>

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

event

object

required

Show child attributes

event.id

string<uuid>

required

Unique event ID

event.type

string

required

Event type

event.timestamp

string<date-time>

required

Event timestamp in UTC

subscription

object

required

Show child attributes

subscription.id

string<uuid>

required

Webhook subscription ID

subscription.workspaceId

string

Workspace ID

payload

object

required

Show child attributes

payload.contact

object

required

Show child attributes

payload.contact.firstName

string

required

First name

payload.contact.id

integer

Unique ID

payload.contact.email

string<email>

Primary email address

payload.contact.lastName

string

Last name

payload.contact.phone

string

Phone number

payload.contact.title

string

Job title

payload.contact.company

string

Organization name

payload.contact.companySize

string

Organization employee count

payload.contact.industry

string

Business sector

payload.contact.linkedInProfile

string<uri>

LinkedIn profile URL

payload.contact.linkedInSalesNavigator

string<uri>

Sales Navigator URL

payload.contact.linkedInRecruiter

string<uri>

Recruiter URL

payload.contact.city

string

City of residence

payload.contact.state

string

State/province

payload.contact.country

string

Country

payload.contact.timeZone

string

Timezone identifier

payload.contact.domain

string

Email domain

payload.contact.phoneStatus

string

Phone validation status

payload.contact.notes

string

Additional information

payload.contact.addingDate

string<date-time>

Creation timestamp

payload.contact.customFields

object[]

User-defined fields

Show child attributes

payload.contact.customFields.key

string

required

Field identifier

payload.contact.customFields.value

string

required

Field content

Example:

{
  "id": 12345,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "title": "Senior Product Manager",
  "company": "Tech Solutions Inc",
  "domain": "company.com",
  "city": "San Francisco",
  "state": "CA",
  "country": "United States",
  "timeZone": "America/Los_Angeles",
  "phone": "+1-415-555-0123",
  "phoneStatus": "verified",
  "linkedInProfile": "https://www.linkedin.com/in/johndoe",
  "linkedInSalesNavigator": "https://www.linkedin.com/sales/profile/123456",
  "linkedInRecruiter": "https://www.linkedin.com/recruiter/profile/789012",
  "companySize": "501-1000",
  "industry": "Software & Technology",
  "notes": "Met at SaaS Conference 2024",
  "addingDate": "2024-03-08T10:00:00Z",
  "customFields": [
    {
      "key": "leadSource",
      "value": "Conference"
    },
    { "key": "budget", "value": "100k-250k" }
  ]
}

payload.sequence

object

Show child attributes

payload.sequence.id

integer

required

Sequence ID

payload.sequence.stepNumber

integer

Current step index

payload.customFields

object

Custom fields for the contact

Show child attributes

payload.customFields.{key}

string

payload.data

object

Event-specific fields

attempt

integer

Delivery attempt count for this event

Replay failed event Get webhook event by Id

⌘I

Introduction

API Documentation

List webhook events

Authorizations

Query Parameters

Response