Skip to main content
POST
/
locations
/
{locationId}
/
webhook-endpoints
Register an outbound webhook
curl --request POST \
  --url https://api.pickupbell.com/locations/{locationId}/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "url": "<string>",
  "events": []
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "url": "<string>",
    "events": [],
    "active": true,
    "last_delivered_at": "2023-11-07T05:31:56Z",
    "last_error": "<string>",
    "failure_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "disabled_at": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Location-scoped API token from Settings → API & MCP.

Path Parameters

​
locationId
string
required

Location UUID or slug (e.g. premier-hvac).

Body

application/json
​
label
string
required
​
url
string<uri>
required

Must be https://

​
events
enum<string>[]
required
Minimum array length: 1
Available options:
call.ended,
call.emergency,
lead.created,
lead.updated,
booking.created,
booking.updated,
spam.blocked

Response

201 - application/json

Created

​
data
object

Customer-registered outbound webhook. secret is only ever returned at creation time; subsequent reads omit it.