Partner Webhooks

Update webhook

Update an existing webhook configuration (partial update).

patch/api/v1/partners/{partner_id}/webhooks/{webhook_id}

Request

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

Path parameters

partner_idstring required

Partner ID

webhook_idstring required

Webhook ID (32-character hex string)

Request body

urlstring uri nullable

HTTPS URL to receive webhook events

secretstring nullable

New secret for webhook authentication. Pass empty string to remove.

enabledboolean nullable

Whether the webhook is enabled

Example request

{
  "enabled": false
}

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.