What is an Event

An event is a triggered process which occurs at a specific date/time and provides either a JSON document or an XML string to a receiver. The receiver can either be a webhook (via JSON or XML) or a push/add operation into a job queue (AWS SQS).

An example might be a new Purchase Order you receive on your website and you want to send a reminder email 30 days after the order. You can create an event 30 days from now and ask anticipated.io to contact your site via an event with the payload when the event is triggered. In this example we might have a payload that looks like the following:

{
  "order": 23523,
  "customer": 234634
}

When the event triggers it will send the payload to your endpoint (your information is persisted and sent via the "document" attribute):

{
  "id": "AXsUdzVG5k6MgpFzeg1CZS",
  "when": "2022-06-16T22:09:00.000Z",
  "build": "v20220601",
  "document": {
    "order": 23523,
    "customer": 234634
  }
}

Note: "id" is the ID of the event and "when" is the date/time of the event which was triggered and "build" is the release of the anticipated.io system