Skip to main content
POST
/
webhooks
Create 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": {
    "integration.created": true,
    "integration.updated": true,
    "integration.deleted": true,
    "connection.created": true,
    "connection.updated": true,
    "connection.deleted": true,
    "connection.refreshed": true,
    "connection.disabled": true
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "events": {
    "integration.created": true,
    "integration.updated": true,
    "integration.deleted": true,
    "connection.created": true,
    "connection.updated": true,
    "connection.deleted": true,
    "connection.refreshed": true,
    "connection.disabled": true
  },
  "lastTriggeredAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "signature": "<string>"
}

Authorizations

​
Authorization
string
header
required

Pass the API key as a bearer token.

Body

application/json
​
name
string
required

Webhook display name.

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

Destination URL for webhook deliveries.

​
events
object
required

Event flags. At least one event must be set to true.

Response

Webhook created successfully.

​
id
string
required

Webhook identifier.

​
name
string
required
​
url
string<uri>
required
​
events
object
required
​
lastTriggeredAt
string<date-time> | null
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
signature
string
required

Shared secret used to sign webhook deliveries.