aYOUne
← Automation API

Events

Singular: Event — Base URL: https://automation-api.ayoune.app — Access: read-only — Machine-readable spec (JSON · YAML)

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6a94f3c0b0e2f4c2c2123c93",
    "_consumerID": "65d17fffc681100012970857",
    "ayoune_fp": [],
    "environment": "production",
    "modelName": "advertiserapis",
    "domain": "ayoune.core",
    "origin": "ayoune-api-affiliate-develop",
    "category": "advertiserapis",
    "action": "create",
    "label": "6a94f3c0b0e2f4c2c2123c8c",
    "evt_data": {
      "_id": "6a94f3c0b0e2f4c2c2123c8c",
      "title": "CROWDED_VIOLET_GREEDO",
      "isDraft": true,
      "createdBy": "6045f4d25704710012485569",
      "createdAt": "2026-08-31T03:23:44.075Z",
      "updatedAt": "2026-08-31T03:23:44.075Z"
    },
    "ts": "2026-08-31T03:23:44.135Z",
    "isDraft": true
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://automation-api.ayoune.app/events/6a94f3c0b0e2f4c2c2123c93",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/65d17fffc681100012970857",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "States",
        "title": "MODEL_STATE",
        "href": "https://api.ayoune.app/config/states",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.states"
      }
    ],
    "debugId": "6a9796f11feb1ce1a4dd315d",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_EVENT",
        "href": "https://api.ayoune.app/automation/events/6a94f3c0b0e2f4c2c2123c93/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_EVENT",
        "href": "https://api.ayoune.app/automation/events/6a94f3c0b0e2f4c2c2123c93",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.23.0",
      "core": "2026.323.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2394",
      "reset": "1788323044",
      "resetDate": "Wed Sep 02 2026"
    },
    "responseTime": 100.412198,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /events List with filters/pagination automation.events.view
GET /events/:id Single record by ID automation.events.view

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.automation.events.find().limit(10).exec();

// Single record
const one = await ay.automation.events.findById('OBJECT_ID').exec();

See also