CustomEventType resource

Methods

  • post - Create custom event type
  • get - Get custom event type by Id

Resource

{
    "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
alias string

The alias of the custom event type

 Optional
category string

The category of the custom event type
createdAt date-time

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

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

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

 Optional
fields[].id string

The identifier of the field
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
fields[].jsonPointerPath string

The JSON Pointer Path used to extract the field value

 Optional
fields[].name string

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

The allowed values for checkbox and radio fields

 Optional
fields[].options[].id string

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

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

Whether the field is required
fields[].type string

The type of the field

Possible values are:

  • text
  • email
  • decimal
  • integer
  • date
  • phone
  • boolean
  • checkbox
  • radio
icon string

The icon of the custom event type
id string

The identifier of the custom event type
name string

The name of the custom event type
receiveType string

The receive type of the custom event type

Possible values are:

  • webhook
  • api
  • web/mobile-app
 Optional
updatedAt date-time

The date of the last update in ISO8601 format

 Optional
webhookHeaders[] array

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

 Optional
webhookHeaders[].name string

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

The value of the webhook header
webhookUrl string

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

 Optional