Retrieve a list of custom events

GET 
/events

Returns a list of all Custom Events you have enabled in Alloy Embedded.

Request

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

data

object[]

Array [

name string

description string

body

object

name string

email string

]

Example (from schema)

{
  "data": [
    {
      "name": "Customer Created",
      "description": "This event is invoked every time a customer is created in your app",
      "body": {
        "name": "Gregg",
        "email": "support@runalloy.com"
      }
    }
  ]
}

Result

{
    "data": [
        {
            "name": "Customer Created",
            "description": "This event is invoked every time a customer is created in your app",
            "body": {
                "name": "Gregg",
                "email": "support@runalloy.com"
            }
        },
        {
            "name": "Order created",
            "description": "Triggers when an order is created in ACME",
            "body": {
                "orderId": "0001",
                "orderName": "My order",
                "customerEmail": "support@runalloy.com",
                "customerPhone": "1234567891"
            }
        },
        {
            "name": "Invoke Slack",
            "description": "Invokes Slack",
            "body": {
                "name": "New order created"
            }
        }
    ]
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...