Create a webhook endpoint
SynapseOrch Cloud only. A URL sent the events its patterns match: an event's name
(knowledge.document.indexed), a family's (knowledge.*) or *; Knowledge's events
when events is absent. The answer holds the endpoint's signing secret, shown this
once. Each delivery is {id, type, created_at, data} with X-Synapse-Timestamp, signed as
X-Synapse-Signature-V2: sha256=<HMAC-SHA256 of "{X-Synapse-Timestamp}.{body}">: verify
that, and refuse a delivery whose timestamp is more than 5 minutes from your clock.
X-Synapse-Signature (the body alone) is kept for receivers written against it.
At most 10 endpoints an organization.
More in Webhooks.
apiKeyAuthorizationBearer <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.
application/json- body
url*string1 <= length <= 2000events?array<string>|nullSuccessful Response
application/json- response
id*stringurl*stringevents*array<string>active*booleandisabled_reason*string|nulldisabled_at*|nullconsecutive_failures*integercreated_at*stringdate-timeupdated_at*stringdate-timesecret*stringCloud only
curl -X POST "https://api.synapseorch.com/api/v1/webhooks" \ -H "Authorization: Bearer sk-syn-..." \ -H "Content-Type: application/json" \ -d '{ "url": "string" }'{ "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", "secret": "string"}