GET
/
v2
/
webhooks
/
{Id}
curl --request GET \
  --url https://api.usecloudpress.com/v2/webhooks/{Id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "endpoint": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ],
  "connections": [
    {
      "id": 123,
      "name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

The ID of the webhook to retrieve.

Response

200
application/json
Success

Describes a webhook.

​
id
integer

The ID of the webhook.

​
endpoint
string

The endpoint that will be called when the webhook is triggered.

​
description
string | null

An optional description of the purpose of the webhook.

​
events
string[]

The events that will trigger this webhook.

​
connections
object[]

The connections for which this webhook will be triggered.

Create WebhookDelete Webhook