Skip to main content
PUT
/
webhooks
/
{webhook_id}
{
  "id": 123,
  "webhook_id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "events": [
    "sent"
  ],
  "is_active": true,
  "retry_count": 123,
  "timeout_seconds": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret_key": "<string>",
  "headers": {},
  "created_by": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
webhook_id
integer
required

Body

application/json

Modelo para atualização de webhook

​
name
string | null
Required string length: 1 - 255
​
url
string<uri> | null
Required string length: 1 - 2083
​
events
enum<string>[] | null
Minimum array length: 1

Tipos de eventos de email que podem disparar webhooks

Available options:
sent,
delivered,
bounced,
soft_bounced,
hard_bounced,
opened,
clicked,
complaint,
unsubscribed,
deferred,
rejected,
suppressed,
test
​
secret_key
string | null
Maximum string length: 255
​
is_active
boolean | null
​
retry_count
integer | null
Required range: 0 <= x <= 10
​
timeout_seconds
integer | null
Required range: 5 <= x <= 300
​
headers
Headers · object

Response

Successful Response

Modelo de resposta para webhook

​
id
integer
required
​
webhook_id
string
required
​
name
string
required
​
url
string
required
​
events
enum<string>[]
required

Tipos de eventos de email que podem disparar webhooks

Available options:
sent,
delivered,
bounced,
soft_bounced,
hard_bounced,
opened,
clicked,
complaint,
unsubscribed,
deferred,
rejected,
suppressed,
test
​
is_active
boolean
required
​
retry_count
integer
required
​
timeout_seconds
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
secret_key
string | null
​
headers
Headers · object
​
created_by
string | null