Skip to main content
POST
/
v3
/
webhooks
Create a webhook subscription
curl --request POST \
  --url https://api.reply.io/v3/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "email_replied",
  "url": "https://example.com/hooks/reply",
  "scope": "Personal",
  "enabled": true,
  "payloadConfig": {
    "includeEmailUrl": true,
    "includeEmailText": false,
    "includeProspectCustomFields": true
  }
}
'
{
  "id": 1823,
  "eventType": "email_replied",
  "url": "https://example.com/hooks/reply",
  "scope": "Personal",
  "enabled": true,
  "createdAt": "2026-04-17T12:00:00+00:00",
  "payloadConfig": {
    "includeEmailUrl": true,
    "includeEmailText": false,
    "includeProspectCustomFields": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Body

application/json

Request body for creating a webhook subscription.

​
eventType
string
required

Event type this subscription should fire on. Must be one of the values returned by GET /v3/webhooks/events.

Example:

"email_replied"

​
url
string<uri>
required

Absolute http/https URL that will receive the webhook payload.

Maximum string length: 1024
Example:

"https://example.com/hooks/reply"

​
scope
enum<string>

Scope that determines which users' activity triggers the webhook.

  • Personal — fires only for activity of the subscription owner.
  • Team — fires for activity of any member of the owner's team. Creation requires the current user to be the team owner for private teams; anyone can create for public teams.
  • Organization — reserved for future use. The API currently rejects creation/update with this value (errorCode: 5).
Available options:
Personal,
Team,
Organization
Example:

"Personal"

​
enabled
boolean
default:true

Create the subscription in an enabled (firing) state. Defaults to true. After creation, toggle the state via the dedicated POST /v3/webhooks/{id}/enable and POST /v3/webhooks/{id}/disable endpoints.

​
payloadConfig
WebHookPayloadConfig · object

Optional flags that enrich the delivered webhook payload with extra fields from the originating email/contact.

Example:
{
  "includeEmailUrl": true,
  "includeEmailText": false,
  "includeProspectCustomFields": true
}

Response

Webhook subscription created successfully.

A webhook subscription. The subscription fires a single event type to a configured URL when activity matching the subscription's scope occurs.

​
id
integer
read-only

Unique identifier for the webhook subscription.

​
eventType
string

Event type this subscription fires on. One of the values returned by GET /v3/webhooks/events.

Example:

"email_replied"

​
url
string<uri>

Absolute http/https URL that receives the webhook payload.

Example:

"https://example.com/hooks/reply"

​
scope
enum<string>

Scope that determines which users' activity triggers the webhook.

  • Personal — fires only for activity of the subscription owner.
  • Team — fires for activity of any member of the owner's team. Creation requires the current user to be the team owner for private teams; anyone can create for public teams.
  • Organization — reserved for future use. The API currently rejects creation/update with this value (errorCode: 5).
Available options:
Personal,
Team,
Organization
Example:

"Personal"

​
enabled
boolean

If false, the subscription does not fire. Toggle via the dedicated POST /v3/webhooks/{id}/enable and POST /v3/webhooks/{id}/disable endpoints — the state cannot be changed through PUT.

​
createdAt
string<date-time>
read-only

ISO-8601 timestamp (UTC) when the subscription was created.

​
payloadConfig
WebHookPayloadConfig · object

Optional flags that enrich the delivered webhook payload with extra fields from the originating email/contact.

Example:
{
  "includeEmailUrl": true,
  "includeEmailText": false,
  "includeProspectCustomFields": true
}