Skip to main content
PATCH
/
webhook-endpoints
/
{id}
cURL
curl -X PATCH https://api.neuraldraft.io/v1/webhook-endpoints/whe_2NgcaXxFqLPo \
  -H "Authorization: Bearer ndsk_live_yourkey" \
  -H "Content-Type: application/json" \
  -d '{"events":["order.paid","order.fulfilled","order.created","blog_post.published"]}'
{
  "id": "whe_2NgcaXxFqLPo",
  "url": "<string>",
  "events": [],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "last_delivery_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Project API key. Pass as Authorization: Bearer ndsk_live_.... Manage keys via /projects/me/api-keys. Test-mode keys use the ndsk_test_ prefix.

Path Parameters

​
id
string
required
Example:

"whe_2NgcaXxFqLPo"

Body

application/json
​
url
string<uri>
required
​
events
enum<string>[]
required
Minimum array length: 1

All webhook event topics emitted by the platform.

Available options:
blog_post.published,
blog_post.translated,
social_post.published,
social_post.failed,
order.created,
order.paid,
order.fulfilled,
order.cancelled,
order.refunded,
booking.confirmed,
booking.cancelled,
booking.completed,
content.changed,
image.generated,
connect.account_updated
​
is_active
boolean
default:true

Response

Updated.

​
id
string
required
Example:

"whe_2NgcaXxFqLPo"

​
url
string<uri>
required
​
events
enum<string>[]
required

All webhook event topics emitted by the platform.

Available options:
blog_post.published,
blog_post.translated,
social_post.published,
social_post.failed,
order.created,
order.paid,
order.fulfilled,
order.cancelled,
order.refunded,
booking.confirmed,
booking.cancelled,
booking.completed,
content.changed,
image.generated,
connect.account_updated
​
is_active
boolean
required
​
created_at
string<date-time>
required
​
last_delivery_status
enum<string> | null
Available options:
success,
failed,
pending,
null
​
last_delivery_at
string<date-time> | null