Create an external notification

post

https://sandbox.uk.rootplatform.com/v1/insurance/notifications

Create a notification with provider of external. If you use an integration external to Root to send notifications to end customers, you can use this endpoint to record the notification on Root and link it to the relevant entities (such as a policy or claim).

Body Params

channel

string

enum

required

The channel over which the notification is sent.

Allowed:

status

string

enum

required

The status of the notification.

Allowed:

failure_reason

string

Forbidden if status is not rejected. The reason for the notification failure.

notification_type

string

enum

required

The event the notification is linked to.

linked_entities

object

required

Entities linked to the notification.

data

required

An object containing additional data depending on whether the notification channel is email, sms, or other.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success