Skip to main content
PUT
Update a webhook subscription

Authorizations

Authorization
string
header
required

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

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

Path Parameters

id
integer
required

Webhook subscription ID.

Body

application/json

Request body for updating a webhook subscription. PUT performs a full replacement of the mutable fields — every required field listed below must be provided on every call. To toggle the paused state use the dedicated POST /v3/webhooks/{id}/enable / POST /v3/webhooks/{id}/disable endpoints — the enabled flag is not accepted on update.

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>
required

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"

payloadConfig
WebHookPayloadConfig · object

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

Example:

Response

Webhook subscription updated 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: