Create Event

post

https://api.talkdeskapp.com/automated-notifications/events

Creates an Event and publishes an addedEvent.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

automated-notifications:write

Query Params

publisher_name

string

required

length ≥ 1

The name of the publisher.

Body Params

The Event to be created.

external_id

string

length ≥ 1

The external id of the Event.

correlation_id

string

length ≥ 1

The id used to correlate multiple Events.

type

string

required

length ≥ 1

The type of the Event.

source

string

required

length ≥ 1

The source of the Event.

time_zone

string

required

length ≥ 1

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

primary_date

date-time

required

length ≥ 1

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

secondary_date

date-time

length ≥ 1

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.

contacts

array of objects

required

length ≥ 1

The list of Contacts associated with the Event.

contacts*

name

string

required

length ≥ 1

The name of the Contact.

preferred_channel

string

required

length ≥ 1

The preferred channel to use when sending notifications.

channels

array of objects

required

length ≥ 1

The list of channels of the Contact.

channels*

type

string

enum

required

length ≥ 1

The type of channel.

Allowed:

uri

string

required

length ≥ 1

The channel uri (for instance email address or phone number).

data

object

Data with specific properties of the Event.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

Scope

201Event created

400Bad Request

401Unauthorized

403Forbidden