Webhooks

Send a test event

POST
/api/v1/webhooks/{endpoint_id}/test

SynapseOrch Cloud only. A signed webhook.test event to this endpoint alone, delivered as any other: read its outcome in the endpoint's deliveries.

More in Webhooks.

apiKey
headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

endpoint_id*string

Response Body

Successful Response

application/json
  1. response
id*string
event_id*string
event_type*string
state*string
attempts*integer
last_status_code*integer|null
last_error*string|null
created_at*string
Formatdate-time
delivered_at*|null
payload*

Cloud only

curl -X POST "https://api.synapseorch.com/api/v1/webhooks/01920f4e-6b7a-7c3d-9e1f-2a3b4c5d6e7f/test" \  -H "Authorization: Bearer sk-syn-..."
{  "id": "string",  "event_id": "string",  "event_type": "string",  "state": "string",  "attempts": 0,  "last_status_code": 0,  "last_error": "string",  "created_at": "2019-08-24T14:15:22Z",  "delivered_at": "2019-08-24T14:15:22Z",  "payload": {}}