Skip to content

Create a webhook

Request

Register a new webhook endpoint to receive real-time event notifications.

Security
BearerAuth
Bodyapplication/jsonrequired
urlstringrequired
Example:"https://webhook.site/624bbe8c-8939-4db0-952b-8590c7690dc9"
eventsArray of stringsrequired
Example:
[
  "appointment.approved.v1",
  "appointment.denied.v1"
]
curl -i -X POST \
  https://docs.speedysticks.com/_mock/openapi/api/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://webhook.site/624bbe8c-8939-4db0-952b-8590c7690dc9",
    "events": [
      "appointment.approved.v1",
      "appointment.denied.v1"
    ]
  }'

Responses

Webhook created successfully

Bodyapplication/json
idinteger
Example:1
urlstring
Example:"https://api.speedysticks.com/webhook-endpoint"
eventsArray of strings
Example:
[
  "appointment.approved.v1",
  "appointment.denied.v1"
]
Response
{
  "id": 1,
  "url": "https://api.speedysticks.com/webhook-endpoint",
  "events": [
    "appointment.approved.v1",
    "appointment.denied.v1"
  ]
}