Get Event Types

List event types

GET/v1/event_types

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Event Types action (under management).
Fill in the fields below, then reference the result from later steps as {{getEventTypes.response.data}}.

Request

Query parameters

namestring

Filter results to event types with the given name. This parameter implies `includeOldVersions`.

includeOldVersionsboolean

Include all versions of every event type.

Default false

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

Response

Returns 200 with an object. Read it in later steps with {{getEventTypes.response.data.<field>}}.

totalResultSizeinteger (int64)

dataarray<object>

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

titlestringrequired

The human-friendly name for this event type.

namestringrequired

The integration name for this event type. This will be used in URLs and cannot be changed after an event type has been created.

descriptionstring

A description of what the event represents.

json

{
  "totalResultSize": 1,
  "data": [
    {
      "created": {},
      "name": "surveyCompleted",
      "description": "The survey was submitted by the customer.",
      "id": 6,
      "title": "Survey Completed"
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?