API Reference
Start typing to search…

Create a new webhook

post https://api.sikoia.com/v2/webhooks

Creates a webhook for one or more events.

A webhook is an HTTP request that keeps your system informed about changes in the Sikoia Platform in real-time. Refer to our Guides section for additional information on webhooks.
You can retrieve a complete list of supported event_types by using the GET/v2/webhooks/event-types endpoint.

Log in to see full request history
Body Params
string
required
length between 1 and 50

The user friendly, case sensitive, name for a webhook - it does not have to be unique

string
required
length between 1 and 2048

The absolute HTTPS URL that a POST request will be made to when the webhook is triggered

string | null

Optional value if you need to associate a webhook instance with a reference in your system

event_types
array of strings
required
length ≥ 1

Supported events a webhook can subscribe to

event_types*
Responses

Updated 11 months ago

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago