API ReferenceEvent Sources

Schedule Event Sources

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
event_typestringRequiredformat: "text"
The type of the event.
idstringRequiredformat: "id"
The event source's ID.
payloadstringRequiredformat: "byte"
The raw payload of the event.
event_keystringOptionalformat: "text"

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

publish_atstringOptionalformat: "date-time"
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_existsbooleanOptional
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_keystring or nullformat: "text"

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.

Errors