v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Org Events

Retrieves all events configured for the org. This includes both standard and custom events.

You can also use the query parameter to fetch details of a specific event.

get/events

Query parameters

eventNamestring required

Name of the event to fetch details of a specific event.

isDuplicateboolean

To filter by duplicate events

source_user_idstring

Response

200

Example response

{
  "data": [
    {
      "clickEventsMeta": {
        "eventId": "87c8b0fb-b825-4b7e-b336-b24e7c389f70",
        "eventName": "CustomerEvent",
        "actions": [
          "EIConsumer"
        ],
        "fields": [
          {
            "name": "customer",
            "type": "customer",
            "attributes": {
              "accountId": {
                "valueType": "ENUM"
              },
              "addCustomerIfNotExists": {
                "value": "true",
                "valueType": "Boolean"
              },
              "identifierType": {
                "value": "MOBILE",
                "valueType": "ENUM"
              },
              "isRequired": {
                "value": "true",
                "valueType": "BOOLEAN"
              },
              "source": {
                "value": "INSTORE",
                "valueType": "ENUM"
              }
            }
          }
        ],
        "status": "UNPUBLISHED",
        "testStatus": "NOT_VERIFIED",
        "description": "sample description",
        "date": 1560941666471
      }
    }
  ]
}