POST
/
api
/
v2
/
public
/
webhook
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": [
    {}
  ]
}'
{
    "webhook_url": "https://mysite.com/cobalt/webhook",
    "webhook_events": [
        "connected-created",
        "workflow-completed"
    ]
}

This API registers a Cobalt webhook.

Request description

Body Parameters

webhook_url
string
required

Provide a url where you wish to listen to the event.

webhook_events
array

Webhooks events to subscribe. Accepted values are, connected-created, connection-deleted, workflow-completed, workflow-errored.

Query Parameters

page
integer
default: "1"

Page number eg: 5

limit
integer
default: "10"

Records per page eg: 10

Response description

webhook_url
string

Registered webhook url

webhook_events
array

Subscribed events.