API Reference

Create Custom Event

post
https://api.whippy.co/v1/custom_events

Creates a custom event.

Returns 201 when the event is successfully created. Returns 202 when the event is queued for async processing.

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

Create Custom Event Params

associated_resources
array of objects

List of Whippy resources associated with the custom event.

associated_resources
string
required

Custom event type.

It can be a resource and event separated with a period, such as "job.assigned". It can be separated with a hyphen, such as "job-assigned".

It can be any string, as we assume that this is an event existing in the external system and there can be different formats for such events.

string

External ID of a related to a custom event.

payload
object

Data related to the custom event, it can have any structure.

date-time

Timestamp of the custom event. It needs to be in ISO 8601 format.

Responses

Callback

Updated about 5 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago