Créer une souscription webhook (secret retourné UNE SEULE fois)

POST

/v1/webhooks

curl --request POST \
  --url https://example.com/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "targetUrl": "https://example.com", "description": "example", "eventTypes": [ "example" ] }'

Authorizations

• ApiKeyAuth
• BearerAuth

Request Body ^required

Media type application/json

object

targetUrl

required

string format: uri

<= 2048 characters

description

string

<= 500 characters

eventTypes

required

Types d’événements à notifier

Array<string>

>= 1 items

Example ^generated

{
  "targetUrl": "https://example.com",
  "description": "example",
  "eventTypes": [
    "example"
  ]
}

Responses

201

Souscription créée — secret retourné UNE SEULE fois

Media type application/json

object

data

required

object

subscription

required

object

id

required

string format: uuid

targetUrl

required

string

status

required

string

description

string

eventTypes

required

Array<string>

createdBy

string

createdAt

string format: date-time

secret

required

Secret HMAC — stocker immédiatement, non récupérable ensuite

string

Example ^generated

{
  "data": {
    "subscription": {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "targetUrl": "example",
      "status": "example",
      "description": "example",
      "eventTypes": [
        "example"
      ],
      "createdBy": "example",
      "createdAt": "2026-04-15T12:00:00Z"
    },
    "secret": "example"
  }
}

400

Corps invalide

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}