Used to retrieve details about a particular scheduled event instance. Every time a scheduled event runs an instance record is created that represents the outcome.

Request Fields

These are passed in at the top level of the request.

Key Type Description
uid string An identifier for a scheduled event instance.

Request Example

{
  "api_key" : "__PROJECT_API__KEY__",
  "uid": "__UID__",
  "schedule": "in 5 hours",
  "metadata": {
    "arguments": {
      "recipients": "test@example.com",
      "headers": {
        "from": "test@example.com",
        "subject": "Example Scheduled Email"
      },
      "content": {
        "text/plain": "This email was sent automatically."
      },
      "attachments": {
        "test.pdf": {
          "content_type": "application/octet-stream",
          "content": {
            "$ref": "http://example.com/resources/example.pdf", 
            "$type": "application/octet-stream",
            "$encode": "base64"
          }
        }
      }
    }
  }
}

Response 200 OK

{
  "response": {
    "status": "ok",
    "uid": "811585c1-43e2-4f2c-b726-9ff07933e9b1"
  },
  "data": {
    "uid": "811585c1-43e2-4f2c-b726-9ff07933e9b1",
    "status": "succeeded",
    "completed_at": "2018-12-18T19:22:00Z",
    "content": "..."
  }
}