Type at least two letters.

    ↑ ↓ to moveEnter to open

    Automations API

    Automations, their activity, and the incoming webhook.

    Updated

    8 live operations. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.

    To try these with your own account, sign in and open Automation → Try the API in the app.

    List your automations

    GET/api/v1/automations
    Scope: audits:readoperationId: listAutomations

    Responses

    200object

    Automations

    1 field
    dataarray of Automation
    13 fields of data
    idstring
    namestring
    enabledboolean
    triggerstring

    One of: webhook, audit_finished

    siteIdstring
    graphAutomationGraph

    One trigger and its actions, connected into one chain.

    hookUrlstring (uri)

    The incoming webhook address. Present only when it was just created or replaced.

    hookPrefixstring or null

    The first characters of the incoming token.

    deliverUrlstring or null (uri)
    signingSecretstring or null

    Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).

    lastTriggeredAtstring or null (date-time)
    createdAtstring (date-time)
    updatedAtstring (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Create an automation from a trigger and its actions

    POST/api/v1/automations
    Scope: audits:writeoperationId: createAutomation

    Supported flows: `trigger.webhook` → `action.run_audit` → `action.send_webhook` (the last step is optional), or `trigger.audit_finished` → `action.send_webhook`. With an incoming webhook the answer carries `hookUrl` once; only its hash is stored. The plan sets how many automations an account keeps (`GET /plans`).

    Request body AutomationCreate

    namestringrequired

    At most 80 characters

    enabledboolean

    Default: true

    graphAutomationGraphrequired

    One trigger and its actions, connected into one chain.

    2 fields of graph
    nodesarray of AutomationNoderequired

    At most 6 items

    5 fields of nodes
    idstringrequired

    At most 40 characters

    typestringrequired

    One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook

    xinteger

    Position on the canvas.

    yinteger
    configobject

    `siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.

    2 fields of config
    siteIdstring
    urlstring (uri)
    edgesarray of objectrequired
    2 fields of edges
    fromstringrequired
    tostringrequired
    {
      "name": "Audit after deploy",
      "graph": {
        "nodes": [
          {
            "id": "trigger",
            "type": "trigger.webhook"
          },
          {
            "id": "audit",
            "type": "action.run_audit",
            "config": {
              "siteId": "site_01JC9Z0000000000000000000"
            }
          },
          {
            "id": "send",
            "type": "action.send_webhook",
            "config": {
              "url": "https://example.com/hooks/metricevo"
            }
          }
        ],
        "edges": [
          {
            "from": "trigger",
            "to": "audit"
          },
          {
            "from": "audit",
            "to": "send"
          }
        ]
      }
    }

    Responses

    201Automation

    Created

    13 fields
    idstring
    namestring
    enabledboolean
    triggerstring

    One of: webhook, audit_finished

    siteIdstring
    graphAutomationGraph

    One trigger and its actions, connected into one chain.

    2 fields of graph
    nodesarray of AutomationNoderequired

    At most 6 items

    5 fields of nodes
    idstringrequired

    At most 40 characters

    typestringrequired

    One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook

    xinteger

    Position on the canvas.

    yinteger
    configobject

    `siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.

    2 fields of config
    siteIdstring
    urlstring (uri)
    edgesarray of objectrequired
    2 fields of edges
    fromstringrequired
    tostringrequired
    hookUrlstring (uri)

    The incoming webhook address. Present only when it was just created or replaced.

    hookPrefixstring or null

    The first characters of the incoming token.

    deliverUrlstring or null (uri)
    signingSecretstring or null

    Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).

    lastTriggeredAtstring or null (date-time)
    createdAtstring (date-time)
    updatedAtstring (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Get one automation with its graph and signing secret

    GET/api/v1/automations/{automationId}
    Scope: audits:readoperationId: getAutomation

    Parameters

    automationIdstring · pathrequired

    Responses

    200Automation

    Automation

    13 fields
    idstring
    namestring
    enabledboolean
    triggerstring

    One of: webhook, audit_finished

    siteIdstring
    graphAutomationGraph

    One trigger and its actions, connected into one chain.

    2 fields of graph
    nodesarray of AutomationNoderequired

    At most 6 items

    5 fields of nodes
    idstringrequired

    At most 40 characters

    typestringrequired

    One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook

    xinteger

    Position on the canvas.

    yinteger
    configobject

    `siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.

    2 fields of config
    siteIdstring
    urlstring (uri)
    edgesarray of objectrequired
    2 fields of edges
    fromstringrequired
    tostringrequired
    hookUrlstring (uri)

    The incoming webhook address. Present only when it was just created or replaced.

    hookPrefixstring or null

    The first characters of the incoming token.

    deliverUrlstring or null (uri)
    signingSecretstring or null

    Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).

    lastTriggeredAtstring or null (date-time)
    createdAtstring (date-time)
    updatedAtstring (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Rename, turn on or off, or replace the graph

    PATCH/api/v1/automations/{automationId}
    Scope: audits:writeoperationId: updateAutomation

    Parameters

    automationIdstring · pathrequired

    Request body

    namestring

    At most 80 characters

    enabledboolean
    graphAutomationGraph

    One trigger and its actions, connected into one chain.

    2 fields of graph
    nodesarray of AutomationNoderequired

    At most 6 items

    5 fields of nodes
    idstringrequired

    At most 40 characters

    typestringrequired

    One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook

    xinteger

    Position on the canvas.

    yinteger
    configobject

    `siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.

    2 fields of config
    siteIdstring
    urlstring (uri)
    edgesarray of objectrequired
    2 fields of edges
    fromstringrequired
    tostringrequired
    {
      "enabled": false
    }

    Responses

    200Automation

    Automation

    13 fields
    idstring
    namestring
    enabledboolean
    triggerstring

    One of: webhook, audit_finished

    siteIdstring
    graphAutomationGraph

    One trigger and its actions, connected into one chain.

    2 fields of graph
    nodesarray of AutomationNoderequired

    At most 6 items

    5 fields of nodes
    idstringrequired

    At most 40 characters

    typestringrequired

    One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook

    xinteger

    Position on the canvas.

    yinteger
    configobject

    `siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.

    2 fields of config
    siteIdstring
    urlstring (uri)
    edgesarray of objectrequired
    2 fields of edges
    fromstringrequired
    tostringrequired
    hookUrlstring (uri)

    The incoming webhook address. Present only when it was just created or replaced.

    hookPrefixstring or null

    The first characters of the incoming token.

    deliverUrlstring or null (uri)
    signingSecretstring or null

    Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).

    lastTriggeredAtstring or null (date-time)
    createdAtstring (date-time)
    updatedAtstring (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Remove an automation; its incoming webhook stops working

    DELETE/api/v1/automations/{automationId}
    Scope: audits:writeoperationId: deleteAutomation

    Parameters

    automationIdstring · pathrequired

    Responses

    204

    Removed

    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Replace the incoming webhook address; the old one stops at once

    POST/api/v1/automations/{automationId}/hook
    Scope: audits:writeoperationId: rotateAutomationHook

    Parameters

    automationIdstring · pathrequired

    Responses

    200Automation

    The automation with its new `hookUrl`, shown once

    13 fields
    idstring
    namestring
    enabledboolean
    triggerstring

    One of: webhook, audit_finished

    siteIdstring
    graphAutomationGraph

    One trigger and its actions, connected into one chain.

    2 fields of graph
    nodesarray of AutomationNoderequired

    At most 6 items

    5 fields of nodes
    idstringrequired

    At most 40 characters

    typestringrequired

    One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook

    xinteger

    Position on the canvas.

    yinteger
    configobject

    `siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.

    2 fields of config
    siteIdstring
    urlstring (uri)
    edgesarray of objectrequired
    2 fields of edges
    fromstringrequired
    tostringrequired
    hookUrlstring (uri)

    The incoming webhook address. Present only when it was just created or replaced.

    hookPrefixstring or null

    The first characters of the incoming token.

    deliverUrlstring or null (uri)
    signingSecretstring or null

    Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).

    lastTriggeredAtstring or null (date-time)
    createdAtstring (date-time)
    updatedAtstring (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    The last 50 triggers and deliveries of an automation

    GET/api/v1/automations/{automationId}/events
    Scope: audits:readoperationId: listAutomationEvents

    Parameters

    automationIdstring · pathrequired

    Responses

    200object

    Events, newest first

    1 field
    dataarray of AutomationEvent
    6 fields of data
    idstring
    runIdstring or null
    kindstring

    One of: triggered, delivered, delivery_failed

    httpStatusinteger or null
    detailstring or null
    createdAtstring (date-time)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Incoming webhook. Starts the audit of the automation it belongs to

    POST/api/v1/hooks/{token}
    PublicoperationId: triggerAutomation

    The token in the path is the only credential: send no API key. The body is ignored. Answers `202` with the `runId`; when the audit has finished, the automation's Send webhook step delivers the result. `409 run_in_progress` carries the `runId` of the audit already waiting.

    Parameters

    tokenstring · pathrequired

    Responses

    202object

    Accepted

    3 fields
    runIdstring
    statusstring

    One of: queued, running, succeeded, partial, failed

    automationIdstring
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.