Get a webhook endpoint

GET

/api/v1/webhooks/{endpoint_id}

SynapseOrch Cloud only. One webhook endpoint, without its secret.

Authorization

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.

Path Parameters

endpoint_id*string

Response Body

Successful Response

application/json

response

id*string

url*string

events*array<string>

active*boolean

disabled_reason*string|null

disabled_at*|null

consecutive_failures*integer

created_at*string

Formatdate-time

updated_at*string

Formatdate-time

Cloud only

curl -X GET "https://api.synapseorch.com/api/v1/webhooks/01920f4e-6b7a-7c3d-9e1f-2a3b4c5d6e7f" \  -H "Authorization: Bearer sk-syn-..."

{  "id": "string",  "url": "string",  "events": [    "string"  ],  "active": true,  "disabled_reason": "string",  "disabled_at": "2019-08-24T14:15:22Z",  "consecutive_failures": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}