event

Retrieve an event

Retrieves an event with its type and payload.

get/v1/event/{event_id}

Request

Base URL: http://localhost:3030
URL: http://localhost:3030/v1/event/{event_id}
Auth: HTTP bearer

Path parameters

event_idstring required

The event's id, evt_....

Response

The event.

object'event' required

The object's type. Always event.

idstring required

Unique identifier for the object.

type'permit.created' | 'case.created' required

The event's type. One of permit.created or case.created.

dataobject required

The event's payload, as webhooks receive it: the record's id and href, and the monitor and list_item it matched.

created_atstring date-time required

Time at which the object was created.

hrefstring required

The object's path in the API.

Example response

{
  "id": "evt_01h455vb4pex5vsknk084sn02q",
  "data": {
    "href": "/v1/permit/pmt_01h455vb4pex5vsknk084sn02q",
    "id": "pmt_01h455vb4pex5vsknk084sn02q",
    "list_item": "lsi_01h455vb4pex5vsknk084sn02q",
    "monitor": "mon_01h455vb4pex5vsknk084sn02q"
  },
  "href": "/v1/event/evt_01h455vb4pex5vsknk084sn02q"
}

Changes

No recorded changes to this operation across all 1 revision of this API.