Marketing automation events.
All available methods for resource events.
HTTP method | Endpoint | Description |
---|---|---|
[badge-green POST] | /events | Create a new event |
[badge-blue GET] | /events | Get information about all events |
[badge-blue GET] | /events/{event_id} | Get information about a specific event |
Add a new event
[badge-green POST] /events
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
event | Event | Event resource | Yes |
Status code: 201 Created
Output structure : object
Parameter name | Type | Description |
---|---|---|
event_id | string | The unique id of the event |
Get information about all events as a list
[badge-blue GET] /events
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 |
event_type_id | string | The unique id of the event type | No |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
events | Event[] | Collection of all events |
total_items | integer | Count of all found events |
Get information about a specific event
[badge-blue GET ]/events/{event_id}
Parameter name | Type | Description |
---|---|---|
event_id | string | The unique id for the event |
Status code: 200 OK
Output structure : Event