Skip to main content
GET
/
events
/
eventName
/
{eventName}
curl --request GET \
  --url https://api.autosend.com/v1/events/eventName/order_completed \
  --header 'Authorization: Bearer AS_your-project-api-key'
{
  "success": true,
  "data": {
    "id": "60d5ec49f1b2c72d9c8b1234",
    "eventName": "order_completed",
    "description": "Fired when a customer completes a checkout",
    "properties": [
      {
        "propertyName": "order_total",
        "type": "number",
        "description": "Total order value in USD",
        "suggestedValues": []
      },
      {
        "propertyName": "currency",
        "type": "string",
        "suggestedValues": ["USD", "EUR", "GBP"]
      }
    ],
    "createdAt": "2026-05-08T10:00:00.000Z",
    "updatedAt": "2026-05-08T10:00:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.autosend.com/llms.txt

Use this file to discover all available pages before exploring further.

Looks up a single event definition by its eventName. Soft-deleted events are not returned.
curl --request GET \
  --url https://api.autosend.com/v1/events/eventName/order_completed \
  --header 'Authorization: Bearer AS_your-project-api-key'
{
  "success": true,
  "data": {
    "id": "60d5ec49f1b2c72d9c8b1234",
    "eventName": "order_completed",
    "description": "Fired when a customer completes a checkout",
    "properties": [
      {
        "propertyName": "order_total",
        "type": "number",
        "description": "Total order value in USD",
        "suggestedValues": []
      },
      {
        "propertyName": "currency",
        "type": "string",
        "suggestedValues": ["USD", "EUR", "GBP"]
      }
    ],
    "createdAt": "2026-05-08T10:00:00.000Z",
    "updatedAt": "2026-05-08T10:00:00.000Z"
  }
}

Authorizations

Authorizations
string | header
required
Project API key header of the form Bearer AS_<key>.

Path Parameters

eventName
string
required
Name of the event to fetch. ASCII letters, digits, and underscores only.Maximum length: 64Example: "order_completed"

Response

Event retrieved successfully
success
boolean
Indicates if the request was successfulExample: true
data
object
The event definition

Error Responses

404 - Event not found
object
{
  "success": false,
  "error": {
    "message": "Event not found",
    "code": "EVENT_NOT_FOUND"
  }
}