Skip to content

Webhooks · API reference

Event subscriptions, their deliveries and their test.

List webhook subscriptions

GET/webhook-subscriptions

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Whole list by default; with page or limit, paginated (25 by default, 500 at most).

Parameters

NameInTypeRequiredDescription
pagequeryintegerno
limitqueryintegerno
pagequeryintegernoNuméro de page, à partir de 1
limitqueryintegernoÉléments par page (500 au plus)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Subscribe to events

POST/webhook-subscriptions

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringnoUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Request body

`{url, events: [...], type_id?}` — le secret de signature n'est donné qu'ici

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com/webhooks/artibox","events":["reservation.creee","reservation.annulee"]}'

Responses

  • 201 Created
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Read a subscription

GET/webhook-subscriptions/{id}

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Update a subscription

PUT/webhook-subscriptions/{id}

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

`{url, events, type_id?, active}` — réactiver remet à zéro le compte des échecs

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions/{id}' \
  -H "x-api-key: $RDV_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com/webhooks/artibox","events":["reservation.creee"],"active":true}'

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Delete a subscription

DELETE/webhook-subscriptions/{id}

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 204 Done, no content
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 429 Too many calls: wait for Retry-After

List a subscription's deliveries (30 days)

GET/webhook-subscriptions/{id}/deliveries

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions/{id}/deliveries' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Send a test event

POST/webhook-subscriptions/{id}/test

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yes
Idempotency-KeyheaderstringnoUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Request body

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/webhook-subscriptions/{id}/test' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 201 Created
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Replay a delivery

POST/webhook-deliveries/{id}/replay

Scope : webhooks:ecrire Manage webhook subscriptions and replay deliveries

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesLa livraison
Idempotency-KeyheaderstringnoUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Request body

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/webhook-deliveries/{id}/replay' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After