integrations

Create an integration

Create an outbound HTTP integration. It starts paused; test-fire it, then resume to go live.

The integration is returned FLAT (fields at the top level, no integration wrapper), the same public shape as GET /api/v1/integrations/{id} and each list item.

Endpoints must be public https URLs (SSRF-guarded; private/internal hosts are rejected).

The auth secret is accepted once and sealed; it is never returned. Omit business_id to attach to the default business.

auth_type is one of none, signature, bearer, api_key (defaults to signature). signature generates a secret when you omit one; bearer / api_key require you to supply one; none sends no auth headers.

post/api/v1/integrations

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/integrations
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

A unique key (e.g. a UUID) that makes a POST safe to retry: replaying the same key within 24h returns the original result instead of acting twice.

Request body

namestring required
descriptionstring nullable
kind'custom_webhook' | 'booking_api' | 'crm_api' | 'calendar' | 'other'
business_idstring uuid nullable
status'active' | 'paused' | 'errored'
method'POST' | 'PUT' | 'PATCH'
endpoint_urlstring uri required
auth_type'none' | 'signature' | 'bearer' | 'api_key'
auth_secretstring
auth_header_namestring
auth_prefixstring
headersobject
sample_payloadobject
timeout_msinteger

Response

Success

organization_idstring uuid required
auth_configobject required
sample_payloadobject required
headersobject required
inbound_enabledboolean required
credential_updated_atstring date-time nullable required
credential_updated_bystring nullable required
inbound_token_hintstring nullable required
inbound_last_atstring date-time nullable required
inbound_last_status'accepted' | 'rejected' | 'null' nullable required
inbound_target_channel'whatsapp' | 'sms' | 'email' | 'null' nullable required
last_success_atstring date-time nullable required
last_failure_atstring date-time nullable required
last_delivery_atstring date-time nullable required
last_health_alert_atstring date-time nullable required
last_test_status'passed' | 'failed' | 'null' nullable required
last_test_atstring date-time nullable required
last_errorstring nullable required
last_response_statusnumber nullable required
idstring uuid required
business_idstring uuid nullable required
namestring required
descriptionstring nullable required
kind'custom_webhook' | 'booking_api' | 'crm_api' | 'calendar' | 'other' required
status'active' | 'paused' | 'errored' required
method'POST' | 'PUT' | 'PATCH' required
endpoint_urlstring required
auth_type'none' | 'signature' | 'bearer' | 'api_key' required
has_secretboolean required
health_status'unknown' | 'healthy' | 'degraded' | 'failing' required
success_countnumber required
failure_countnumber required
timeout_msnumber required
created_atstring date-time required
updated_atstring date-time required
connector_keystring nullable required
connection_state'pending' | 'connected' | 'expiring' | 'needs_reauth' | 'revoked' | 'null' nullable required
connection_state_sincestring nullable required
connection_state_reasonstring nullable required
external_account_labelstring nullable required
request_idstring required

Example response

{
  "id": "75cafe56-e3f9-4253-8f2b-c51090d65540",
  "business_id": "22222222-2222-4222-9222-222222222222",
  "name": "Booking CRM",
  "endpoint_url": "https://api.example.com/blueticked/hook",
  "has_secret": true,
  "timeout_ms": 10000,
  "created_at": "2026-07-01T08:00:00.000Z",
  "updated_at": "2026-07-01T08:00:00.000Z",
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

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