Skip to main content
PATCH
/
webhook-endpoints
/
{webhook_endpoint_id}
Update a webhook endpoint
curl --request PATCH \
  --url https://api.pulsewave.dev/v1/webhook-endpoints/{webhook_endpoint_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "enabled_events": []
}
'
{
  "id": "we_9k2m5p",
  "object": "webhook_endpoint",
  "url": "<string>",
  "enabled_events": [],
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

All requests must include Authorization: Bearer <api_key>. Keys are prefixed pw_live_ or pw_test_. See Authentication.

Path Parameters

​
webhook_endpoint_id
string
required
Example:

"we_9k2m5p"

Body

application/json
​
url
string<uri>
​
enabled_events
enum<string>[]
Available options:
message.sent,
message.delivered,
message.bounced,
message.opened,
message.clicked,
message.complained,
contact.unsubscribed,
domain.verified
​
status
enum<string>
Available options:
enabled,
disabled

Response

The updated webhook endpoint

​
id
string
Example:

"we_9k2m5p"

​
object
enum<string>
Available options:
webhook_endpoint
​
url
string<uri>
​
enabled_events
enum<string>[]
Available options:
message.sent,
message.delivered,
message.bounced,
message.opened,
message.clicked,
message.complained,
contact.unsubscribed,
domain.verified
​
status
enum<string>
Available options:
enabled,
disabled
​
created_at
string<date-time>