GET
/
api
/
v2
/
public
/
webhook
/
:id
Get webhook by ID
curl --request GET \
  --url https://api.gocobalt.io/api/v2/public/webhook/:id \
  --header 'x-api-key: <api-key>'
{
    "is_enabled": true,
    "webhook_events": [
        "Connection Created",
        "Connection Deleted",
        "Workflow Completed",
        "Workflow Errored",
        "Connection Expired"
    ],
    "webhook_url": "https://webhook-test.com/558cf4700d31e6ded9b097ca09686439",
    "_id": "66e5701971ff81574d55b2ba",
    "createdAt": "2024-09-14T11:14:33.368Z",
    "webhook_type": "slack"
}
This API fetches a registered Cobalt webhook details by ID.

Request description

Path Parameters

id
string
required
Unique webhook id.

Response description

is_enabled
boolean
Whether the webhook is active or not.
webhook_events
array
Webhooks events subscribed. Accepted values are, Connection Created, Connection Deleted, Workflow Completed, Workflow Errored, Connection Expired.
webhook_url
string
Webhook URL to listen to the events.
_id
string
Unique ID of the webhook.
webhook_type
string
The type of webhook. Accepted values are default and slack.
{
    "is_enabled": true,
    "webhook_events": [
        "Connection Created",
        "Connection Deleted",
        "Workflow Completed",
        "Workflow Errored",
        "Connection Expired"
    ],
    "webhook_url": "https://webhook-test.com/558cf4700d31e6ded9b097ca09686439",
    "_id": "66e5701971ff81574d55b2ba",
    "createdAt": "2024-09-14T11:14:33.368Z",
    "webhook_type": "slack"
}