Jump to

• Request
• Response
• Examples

Fetch All the Custom Events

get

/rest/api/v1.3/events

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Custom Events

Type: array

Title: Custom Events

Show Source

• Array of: object Custom Events
  Title: Custom Events

{
    "title":"Custom Events",
    "type":"array",
    "items":{
        "$ref":"#/definitions/events"
    }
}

Nested Schema : Custom Events

Type: object

Title: Custom Events

Show Source

• description: string
  The description of the custom event
• eventName: string
  The name of the custom event
• eventType: string
  The type of the custom event

{
    "title":"Custom Events",
    "type":"object",
    "properties":{
        "eventName":{
            "description":"The name of the custom event",
            "type":"string"
        },
        "description":{
            "description":"The description of the custom event",
            "type":"string"
        },
        "eventType":{
            "description":"The type of the custom event",
            "type":"string"
        }
    },
    "required":[
        "eventName",
        "description",
        "eventType"
    ]
}

Back to Top

Examples

Get all custom events for an account

The following example shows how to retrieve the names and descriptions of all custom events for an account. This can be helpful for using the Trigger Custom Event API, which requires a valid custom event name.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

Sample Request URL:

    /rest/api/v1.3/events
	

Sample Response: Success

The response is a list of custom event names and their descriptions.

 [
    {
        "eventName": "My_Test",
        "description": "This is a test custom event.",
        "eventType": "1"
    },
    {
        "eventName": "My_Test_Mobile",
        "description": "Test custom event that includes mobile RIIDs",
        "eventType": "1"
    },
    {
        "eventName": "Test3",
        "description": "Test event 3",
        "eventType": "1"
    }
]
	

Sample Response: Failure

 {
   "type": "",
   "title": "Custom event not found",
   "errorCode": "CUSTOM_EVENT_NOT_FOUND",
   "detail": "Account : acctname : does not have any custom events.",
   "errorDetails": []
} 
     

Back to Top