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.

application_id

string

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

document_keys

array of strings

Keys of the organization documents to render for the communication. The email attaches them, and the SMS template can link each one as {{trackedDocumentLink documents.<key>}}. Supplying this replaces the email and SMS templates' configured document_keys wholesale, so an empty array renders no organization documents; omit it to use the templates' own lists. 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. A key naming a document about an entity this event type cannot carry (for example a claim document on a policy event) is rejected with a 400. Forbidden if custom_event_type is application.

document_keys

Response

200

Success

Language

Credentials

Basic

base64

URL

Loading…

Response

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