Create enterprise webhook

Create an HTTPS webhook subscription with DDEX event filters and return its HMAC signing secret exactly once.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Unique request key. Reuse with the same body replays the result; reuse with a different body returns a conflict.

Length8 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 150

endpoint_url*string

Match^https://

Formaturi

Lengthlength <= 2048

events*array<>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/webhooks" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "name": "DDEX operations",    "endpoint_url": "https://integrator.example/webhooks/spacemedia",    "events": [      "ddex.delivery.status_changed",      "ddex.delivery.failed",      "ddex.import.completed"    ]  }'

{  "data": {    "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",    "name": "string",    "endpoint_url": "http://example.com",    "events": [      "ddex.delivery.status_changed"    ],    "active": true,    "secret_configured": true,    "secret_rotated_at": "2019-08-24T14:15:22Z",    "previous_secret_valid_until": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "signing_secret": "pa$$word"  },  "secret_values_returned": true}

Authorization

Header Parameters

Request Body

Response Body

201application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`