Create Event

Creates an Event and publishes an addedEvent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

automated-notifications:write

Query Params
string
required
length ≥ 1

The name of the publisher.

Body Params

The Event to be created.

string
length ≥ 1

The external id of the Event.

string
length ≥ 1

The id used to correlate multiple Events.

string
required
length ≥ 1

The type of the Event.

string
required
length ≥ 1

The source of the Event.

string
required
length ≥ 1

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

date-time
required
length ≥ 1

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

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*
string
required
length ≥ 1

The name of the Contact.

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*
string
enum
required
length ≥ 1

The type of channel.

Allowed:
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
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json