Event Sources Schedule Event

POST

Schedules an event to be published to the specified event source.

Request

This endpoint expects an object.
event_typestringRequired

The type of the event.

idstringRequired

The event source’s ID.

payloadstringRequired

The raw payload of the event.

event_keystringOptional

A unique key for this event (scoped to an event source) used for updating/getting/deleting scheduled events.

publish_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp at which the event should be published. The event is guaranteed to be published after this. If omitted, the event is published immediately.

update_if_existsbooleanOptionalDefaults to false

Whether or not to update an existing scheduled event with the same event key. If this is false, and an event is already scheduled with the same event key, then HTTP 409 Conflict is returned.

Response

Success.

event_keystringOptional

The event key for this event. Auto-generated if the caller doesn’t specify the event key. This may be empty if the event was published immediately.