Test-fire an integration

Send a signed test delivery to the endpoint. On success the integration is switched to active.

Works on a paused integration so you can verify it before going live; a passing test flips it to active.

Rate limited to 10 requests per minute per key, because this makes a real outbound HTTP call.

passed is false (with error) when the endpoint returns a non-2xx or the request fails; the HTTP status is always 200.

An integration that only receives events has no address of its own to test: it is refused with 409 conflict and details.reason "receive_only", and its health is left as it was. Send a sample event from the app to its callback URL instead.

post/api/v1/integrations/{id}/test

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/integrations/{id}/test
Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Request body

Example request

{
  "response_fields": {
    "full_name": "Test Patient",
    "phone": "+27000000000"
  }
}

Response

Success

payloadobject required

passedboolean required

delivery_idstring uuid required

statusnumber nullable required

response_bodystring required

response_mappedobject required

duration_msnumber required

errorstring nullable required

request_idstring required

Example response

{
  "passed": true,
  "delivery_id": "be8b69f2-ca8d-4b2a-a34c-5d43d34e448f",
  "status": 200,
  "response_body": "{\"ok\":true}",
  "duration_ms": 214,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

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