TAtalkdesk
Financial Services Experience Cloud for Insurance

Create and publish an event to the automated-notifications system.

Create and publish an event to the automated-notifications system.

post/fsi-insurance-connections/automated-notifications

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/fsi-insurance-connections/automated-notifications
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: fsi-insurance-connections-automated-notifications:write

Request body

external_idstring

The external id of the Event.

correlation_idstring

The id used to correlate multiple Events.

typestring required

The type of the Event.

external_systemstring required

Name of the external system publising the Event.

time_zonestring required

The timezone offset of the Event. It is used for example with the Rule's calendar preferences.

primary_datestring date-time required

A date in UTC to use to schedule the notifications. The primary date is required.

secondary_datestring date-time

A secondary date in UTC to use to schedule the notifications (can be used for example to represent the end date). It is not required.

dataobject

Data with specific properties of the Event.

Example request

{
  "contacts": [
    {
      "name": "John Doe",
      "preferred_channel": "email",
      "channels": [
        {
          "uri": "mailto:john.doe@talkdesk.com"
        }
      ]
    }
  ]
}

Response

No Content

Changes

No recorded changes to this operation across all 2 revisions of this API.