curl --request POST \
--url https://api.gocobalt.io/api/v2/public/webhook \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"webhook_url": "<string>",
"webhook_events": [
"<string>"
],
"is_enabled": true,
"webhook_type": "<string>"
}'
{
"is_enabled": false,
"webhook_events": [
"Connection Created",
"Connection Deleted",
"Workflow Completed",
"Workflow Errored",
"Connection Expired"
],
"webhook_url": "https://webhookurl.com",
"_id": "66e31564c0287b4136f77ef8",
"createdAt": "2024-09-12T16:23:00.587Z",
"webhook_type": "slack"
}
This API registers a Cobalt webhook.
Request description
Body Parameters
Provide a url where you wish to listen to the event.
Array of strings of webhooks events to subscribe.. Accepted values are, Connection Created, Connection Deleted, Workflow Completed, Workflow Errored, Connection Expired.
Determines whether the webhook is active or not.
The type of webhook. Accepted values are default and slack.
Response description
Whether the webhook is active or not.
Webhook events subscribed.
Timestamp of webhook creation.
Webhook URL to listen to the events.
Unique ID of the webhook.
The type of webhook. Accepted values are default and slack.
{
"is_enabled": false,
"webhook_events": [
"Connection Created",
"Connection Deleted",
"Workflow Completed",
"Workflow Errored",
"Connection Expired"
],
"webhook_url": "https://webhookurl.com",
"_id": "66e31564c0287b4136f77ef8",
"createdAt": "2024-09-12T16:23:00.587Z",
"webhook_type": "slack"
}
