Retrieves a webhook configuration

get https://{region}-api.dotdigital.com/cpaas/webhooks/{webhookId}

Responses

Response body

object

string

The Api Space's unique identifier

_createdOn

date-time

The date (in UTC, ISO 8601 format) that the webhook was created

_createdBy

string

The identity that created the webhook

_updatedOn

date-time

The date (in UTC, ISO 8601 format) that the webhook was last updated

_updatedBy

string

The identity that created the webhook

name

string

required

The name of the webhook configuration

url

string

required

The target url of the webhook configuration

secret

string

The secret of the webhook configuration

subscriptions

array of objects

Events for webhook

subscriptions

object

type

string

type of event

filters

array of objects

Array of used filters

filters

object

name

string

name of filter

value

string

value to watch

batch

boolean

Whether to use event batching, or send single events

maxBatchSize

number

1 to 500

Maximum number of events to batch before it is sent

batchTimeout

number

1 to 60

Maximum duration in seconds to wait before a batch is sent

Headers

object

ETag

string

A unique value representing the version of the webhook configuration, optionally used for optimistic concurrency control on PUT and DELETE

Last-Modified

date-time

The date the webhook configuration was last updated in ISO 8601 format

404

The webhook configuration was not found

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://r1-api.dotdigital.com/cpaas/webhooks/webhookId \
3
     --header 'accept: application/json'


xxxxxxxxxx
24
 
1
{
2
  "id": "string",
3
  "_createdOn": "2025-03-27T05:15:38.325Z",
4
  "_createdBy": "string",
5
  "_updatedOn": "2025-03-27T05:15:38.325Z",
6
  "_updatedBy": "string",
7
  "name": "string",
8
  "url": "string",
9
  "secret": "string",
10
  "subscriptions": [
11
    {
12
      "type": "string",
13
      "filters": [
14
        {
15
          "name": "string",
16
          "value": "string"
17
        }
18
      ]
19
    }
20
  ],
21
  "batch": true,
22
  "maxBatchSize": 0,
23
  "batchTimeout": 0
24
}

200The requested webhook configuration