Event types

List of a marketing automation event types.

Scheme of the MA related resources and their relations

Available methods

All available methods for resource event types.

HTTP method Endpoint Description
[badge-blue GET] /event-types List of all event types
[badge-blue GET] /event-types/{event_type_id} Detail of a specific event type


Get all event types

Get a list of all event types.
[badge-blue GET] /event-types

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Name or part of the name of an event type No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
event_types EventType[] List of all event types
total_items integer Count of all found event types

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/event-types?name=voucher
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NTRlMTU0ODNjYzY3YjM1MTBkMGE4N2VhYWU1MDg4N2M1NTA2OWU0NDM5ZDEwOTEwMWM1ODNiOA==

Example response

HTTP/1.1 200 OK
Date: Thu, 06 Aug 2020 11:39:41 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "event_types": [
      {
        "event_type_id": "82d0f9d976dee39aac13dc7ea",
        "event_group_id": "8bed991c68a470eaaeffbf048",
        "name": "Voucher",
        "state": 1
      }
    ],
    "total_items": 1
  }
}


Get a event type

Get information about a specific event type.
[badge-blue GET] /event-types/{event_type_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
event_type_id string The unique id for the event type Yes

Response

Status code: 200 OK
Output structure : EventType

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/event-types/81dcd5807157297ad7d668e61
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 13 Apr 2021 16:10:47 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "event_type_id": "81dc8d5807157297ad7d68e61",
    "event_group_id": "8bd48117006496e0b178109b8",
    "name": "Release card from account",
    "state": 1
  }
}