Event groups

Events are a unique entity that you can use to record various activities on the customer's account. The structure of events allows you to define different types of events with specific properties, group them, and link to an individual customer account. You can use events to trigger, manage, and create workflow conditions in the Marketing Automation application. You find the list of marketing automation event groups bellow.

Scheme of the MA related resources and their relations


Available methods

All available methods for resource event groups.

HTTP method Endpoint Description
[badge-blue GET] /event-groups List of all event groups
[badge-blue GET] /event-groups/{event_group_id} Detail of a specific event group


Get all event groups

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

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 group No
text_id string Text id of an event group No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
event_groups EventGroup[] List of all event groups
total_items integer Count of all found event groups

Example Request

GET https://<projectURL>/rest-api/customer-interface/v1.0/event-groups
Cache-Control: no-cache
Authorization: Basic Y3VzdG9tZXJfaW50ZXJmYWNlOjhhMjNj2QzMD4Mjk5OE1Nzk4YWVmM2JmMTg5MDU2MDIxMTY4MWFkMjcwNzM3ZWExMjhlODViOGU0MmI1NQ==
Content-Type: application/json

Example response

HTTP/1.1 200 OK
Date: Tue, 13 Apr 2021 17:06:15 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "event_groups": [
      {
        "event_group_id": "86e05affc7a7abefcd513ab400",
        "name": "Shopping Cart",
        "text_id": "shopping_cart",
        "state": 1
      },
      {
        "event_group_id": "83d1d11ea3884a5d33253fe214",
        "name": "Tasks",
        "text_id": "tasks",
        "state": 1
      },
      {
        "event_group_id": "8dcc271b9b80de8b3d1a525052",
        "name": "Points",
        "text_id": "points",
        "state": 1
      },
      {
        "event_group_id": "81c6c712e8888c73d480cbbdb0",
        "name": "Shipments",
        "text_id": "shipments",
        "state": 1
      }
    ],
    "total_items": 4
  }
}


Get a event group

Get information about a specific event group.
[badge-blue GET] /event-groups/{event_group_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
event_group_id string The unique id of the event group Yes

Response

Status code: 200 OK
Output structure : EventGroup

Example Request

GET https://<projectURL>/rest-api/customer-interface/v1.0/event-groups/86e05affc7a7abefcd513ab400

Cache-Control: no-cache
Authorization: Basic Y3VzdG9tZXJfaW50ZXJmYWNlOjhhMGI5ZjZkNjA2Yjjk5OTE1zk4YWVmM2JmMTg5MDU2MDIxMTY4MWFkMjcwNzM3ZWExMjhlODViOGU0MmI1NQ==
Content-Type: application/json

Example response

HTTP/1.1 200 OK
Date: Tue, 13 Apr 2021 17:06:15 GMT
Server: Apache
X-Content-Type-Options: nosniff
X-Frame-Options: sameorigin
X-XSS-Protection: 1; mode=block
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8

{
  "data": {
    "event_group_id": "86e05affc7a7abefc513ab400",
    "name": "Shopping Cart",
    "text_id": "shopping_cart",
    "state": 1
  }
}