Trigger a custom notification event

post

https://sandbox.uk.rootplatform.com/v1/insurance/custom-notification-events/{custom_event_key}/trigger

Queue a custom notification request (or first queue the attachments to be generated — policy documents, organization documents, or both — and send once they exist). A 200 (Success) response does not indicate that the notification was sent successfully. Please refer to the custom notification events guide.

Path Params

custom_event_key

string

required

The key identifiying the custom notification event.

Body Params

custom_event_type

string

enum

required

The type of custom event. Must match the type on the Root management dashboard.

Allowed:

policy_id

string

The UUID of the policy for which the event should be triggered. Required if custom_event_type is policy or payment_method.

payment_id

string

The UUID of the payment for which the event should be triggered. Required if custom_event_type is payment.

claim_id

string

The UUID of the claim for which the event should be triggered. Required if custom_event_type is claim.

document_keys

array of strings

Keys of the organization documents to render and attach to the communication. Supplying this replaces the email template's configured document_keys wholesale, so an empty array attaches no organization documents; omit it to use the template's own list. Each document's published version is rendered, unless the policy was issued against the draft product module definition (sandbox only), in which case its draft is rendered.

document_keys

Response

200

Success

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here!