Skip to main content
POST
/
webhooks
Create a new webhook
curl --request POST \
  --url https://api.bundleup.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "events": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "events": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastTriggeredAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Key authentication using Bearer token

Body

application/json
​
name
string
required

Webhook name

Required string length: 3 - 50
​
url
string<uri>
required

Webhook URL

​
events
object
required

Webhook events configuration (key-value pairs where keys are event names and values are booleans)

Response

Webhook created successfully

​
id
string
required

Unique webhook identifier

​
name
string
required

Webhook name

​
url
string<uri>
required

Webhook URL

​
events
object
required

Webhook events configuration

​
createdAt
string<date-time>
required

When the webhook was created

​
updatedAt
string<date-time>
required

When the webhook was last updated

​
lastTriggeredAt
string<date-time> | null

When the webhook was last triggered