Partner Webhooks

Create webhook

Create a new webhook configuration for the authenticated partner.

post/api/v1/partners/{partner_id}/webhooks

Request

Base URL: https://app.bodyspec.com
URL: https://app.bodyspec.com/api/v1/partners/{partner_id}/webhooks
Auth: one of:
- HTTPBasic (a scheme the document does not define)
- HTTP basic

Path parameters

partner_idstring required

Partner ID

Request body

urlstring uri required

HTTPS URL to receive webhook events

event_type'results_ready' | 'reservation_created' | 'reservation_canceled' | 'reservation_no_show' required

Supported webhook event types.

secretstring nullable

Optional secret for webhook authentication. BodySpec base64-encodes this value and sends it as a Bearer token in the Authorization header of every webhook delivery — i.e. Authorization: Bearer <base64(secret)> (standard base64, with padding).

enabledboolean

Whether the webhook is enabled

Example request

{
  "enabled": true,
  "event_type": "results_ready",
  "secret": "my-webhook-secret",
  "url": "https://your-server.example.com/webhooks/bodyspec"
}

Response

Successful response

webhook_idstring required

Unique identifier for the webhook (Airtable record ID)

urlstring required

URL configured to receive webhook events

event_type'results_ready' | 'reservation_created' | 'reservation_canceled' | 'reservation_no_show' required

Supported webhook event types.

enabledboolean required

Whether the webhook is currently enabled

has_secretboolean required

Whether a secret is configured for this webhook

create_timestring date-time required

When the webhook was created (UTC)

Changes

No recorded changes to this operation across all 1 revision of this API.