Trigger a custom notification event

Queue a custom notification request (or first queue policy documents to be generated if there are email attachments). A 200 (Success) response does not indicate that the notification was sent successfully. Please refer to the custom notification events guide.

Path Params
string
required

The key identifiying the custom notification event.

Body Params
string
enum
required

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

Allowed:
string

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

string

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

string

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

Response
200

Success

Language
Credentials
Basic
base64
:
URL
Response
Click Try It! to start a request and see the response here!