CustomEventTypeList resource

Methods

  • get - List custom event types

Resource

{
    "links": {
        "next": "uri",
        "prev": "uri"
    },
    "results": [
        {
            "alias": "string",
            "category": "string",
            "createdAt": "date-time",
            "fields": [
                {
                    "defaultCountryCode": "string",
                    "id": "string",
                    "isPrimaryKey": "boolean",
                    "jsonPointerPath": "string",
                    "name": "string",
                    "options": [
                        {
                            "id": "string",
                            "label": "string"
                        }
                    ],
                    "required": "boolean",
                    "type": "string"
                }
            ],
            "icon": "string",
            "id": "string",
            "name": "string",
            "receiveType": "string",
            "updatedAt": "date-time",
            "webhookHeaders": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "webhookUrl": "string"
        }
    ]
}

Properties

Name Type Description Additional
links object

The pagination links

 Optional
links.next uri

The next list page url if there are more elements

 Optional
links.prev uri

The previous list page url if there is a previous page
results[] array

The custom event type list
results[].alias string

The alias of the custom event type

 Optional
results[].category string

The category of the custom event type
results[].createdAt date-time

The date of custom event type creation in ISO8601 format
results[].fields[] array

The fields of the custom event type
results[].fields[].defaultCountryCode string

The default country code for phone fields. Required when field type is phone

 Optional
results[].fields[].id string

The identifier of the field
results[].fields[].isPrimaryKey boolean

Whether the field is the primary key. Only one field can be the primary key and it must be of type email. Required when category is receive and receive type is webhook or api
results[].fields[].jsonPointerPath string

The JSON Pointer Path used to extract the field value

 Optional
results[].fields[].name string

The name of the field
results[].fields[].options[] array

The allowed values for checkbox and radio fields

 Optional
results[].fields[].options[].id string

The identifier of the value
results[].fields[].options[].label string

The display label of the value
results[].fields[].required boolean

Whether the field is required
results[].fields[].type string

The type of the field

Possible values are:

  • text
  • email
  • decimal
  • integer
  • date
  • phone
  • boolean
  • checkbox
  • radio
results[].icon string

The icon of the custom event type
results[].id string

The identifier of the custom event type
results[].name string

The name of the custom event type
results[].receiveType string

The receive type of the custom event type

Possible values are:

  • webhook
  • api
  • web/mobile-app
 Optional
results[].updatedAt date-time

The date of the last update in ISO8601 format

 Optional
results[].webhookHeaders[] array

The headers sent with the webhook. Only present when category is send

 Optional
results[].webhookHeaders[].name string

The name of the webhook header
results[].webhookHeaders[].value string

The value of the webhook header
results[].webhookUrl string

The URL of the associated webhook. Only present when category is send

 Optional