Skip to content
view raw .md

Webhooks

Register outbound webhook subscriptions and deliver sample payloads. API-key only.

POST/v1/webhook-subscription/API key

Create a webhook subscription (API-Key only)

Body: url, subscriptions. Event types include FOLLOWUPS_DAILY_FINISHED, FORMS_RESPONSE_CREATED.

Errors

StatusWhen
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
400Validation error
curl -sS -X POST 'https://api.dailybot.com/v1/webhook-subscription/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Try it

This is a copy-only helper — the request is not sent from your browser. Paste the command into your terminal to execute it.

POST/v1/webhook-subscription/sample/API key

Deliver a sample event (API-Key only)

Body: event_type, url.

Errors

StatusWhen
401Missing/invalid/expired credential
403Authenticated but not permitted
429Throttled - Retry-After header set
400Validation error
curl -sS -X POST 'https://api.dailybot.com/v1/webhook-subscription/sample/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Try it

This is a copy-only helper — the request is not sent from your browser. Paste the command into your terminal to execute it.

Webhooks API

Create and manage webhook subscriptions programmatically. Request sample payloads to test your integrations.

See the Webhooks & Events guide for the full list of supported events and payload structures.

Endpoints summary

Method Endpoint Description
POST /v1/webhooks/ Create a webhook subscription
DELETE /v1/webhooks/{id}/ Delete a webhook subscription
POST /v1/webhooks/{id}/sample/ Request a sample payload

POST /v1/webhooks/

Creates a new webhook subscription.

Body parameters

Name Type Required Description
url string (URL) Yes URL to receive webhook payloads. Must use HTTPS.
events array of strings Yes Event types to subscribe to (e.g. ["followups.response.completed"]).
name string No Descriptive name for the webhook.
bearer_token string No Bearer token sent as X-BEARER header for signature verification.
object_ids array of strings No Specific check-in or form UUIDs to filter events (optional).
immediate_sample_event boolean No If true, send a test event immediately after creation.
curl -X POST "https://api.dailybot.com/v1/webhooks/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/dailybot",
    "events": ["followups.response.completed", "kudos.posted"],
    "name": "Production Webhook",
    "bearer_token": "your-secret-token",
    "immediate_sample_event": true
  }'

Response (201 Created):

{
  "id": "wh-1234-abcd",
  "url": "https://your-app.com/webhooks/dailybot",
  "events": ["followups.response.completed", "kudos.posted"],
  "name": "Production Webhook",
  "created_at": "2026-04-06T10:00:00Z"
}

DELETE /v1/webhooks/{id}/

Deletes a webhook subscription.

curl -X DELETE "https://api.dailybot.com/v1/webhooks/wh-1234-abcd/" \
  -H "X-API-KEY: your_api_key"

Response (204 No Content)


POST /v1/webhooks/{id}/sample/

Requests a sample payload for a specific event type. Useful for testing your endpoint.

Body parameters

Name Type Required Description
event string Yes The event type to generate a sample for.
curl -X POST "https://api.dailybot.com/v1/webhooks/wh-1234-abcd/sample/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"event": "followups.response.completed"}'

Response (200 OK):

{
  "status": "sent",
  "event": "followups.response.completed",
  "message": "Sample event payload sent to your webhook URL."
}

Supported events

Event Category
followups.response.completed Check-in
followups.response.updated Check-in
followups.response.deleted Check-in
forms.response.created Forms
forms.response.updated Forms
forms.response.deleted Forms
kudos.posted Kudos
organization.user_activated Organization
organization.user_deactivated Organization
organization.team_user_added Organization
organization.team_user_removed Organization