Benefit Renewals

benefit_renewal_request.created

This event is triggered when a Benefit Renewal Request is created.

postWebhookbenefit_renewal_request.created

Payload

benefit_renewal_request_idstring required

The unique identifier of the benefit renewal request.

company_idstring required

The unique identifier of the related company.

country_codestring required

The ISO 3166-1 3-letter country code.

event_typestring required

The webhook event type identifier.

Example payload

{
  "benefit_renewal_request_id": "ba310525-9282-40c9-8977-14d844bf891a",
  "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59",
  "country_code": "FRA",
  "event_type": "benefit_renewal_request.created"
}

Response

Any 200 response confirms that the webhook was delivered.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.