Automations API
Automations, their activity, and the incoming webhook.
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
Responses
Automations
1 field
13 fields of data
One of: webhook, audit_finished
One trigger and its actions, connected into one chain.
The incoming webhook address. Present only when it was just created or replaced.
The first characters of the incoming token.
Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).
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
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
At most 80 characters
Default: true
One trigger and its actions, connected into one chain.
2 fields of graph
At most 6 items
5 fields of nodes
At most 40 characters
One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook
Position on the canvas.
`siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.
2 fields of config
2 fields of edges
{
"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
Created
13 fields
One of: webhook, audit_finished
One trigger and its actions, connected into one chain.
2 fields of graph
At most 6 items
5 fields of nodes
At most 40 characters
One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook
Position on the canvas.
`siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.
2 fields of config
2 fields of edges
The incoming webhook address. Present only when it was just created or replaced.
The first characters of the incoming token.
Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).
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
Parameters
Responses
Automation
13 fields
One of: webhook, audit_finished
One trigger and its actions, connected into one chain.
2 fields of graph
At most 6 items
5 fields of nodes
At most 40 characters
One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook
Position on the canvas.
`siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.
2 fields of config
2 fields of edges
The incoming webhook address. Present only when it was just created or replaced.
The first characters of the incoming token.
Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).
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
Parameters
Request body
At most 80 characters
One trigger and its actions, connected into one chain.
2 fields of graph
At most 6 items
5 fields of nodes
At most 40 characters
One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook
Position on the canvas.
`siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.
2 fields of config
2 fields of edges
{
"enabled": false
}Responses
Automation
13 fields
One of: webhook, audit_finished
One trigger and its actions, connected into one chain.
2 fields of graph
At most 6 items
5 fields of nodes
At most 40 characters
One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook
Position on the canvas.
`siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.
2 fields of config
2 fields of edges
The incoming webhook address. Present only when it was just created or replaced.
The first characters of the incoming token.
Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).
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
Parameters
Responses
Removed
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
Parameters
Responses
The automation with its new `hookUrl`, shown once
13 fields
One of: webhook, audit_finished
One trigger and its actions, connected into one chain.
2 fields of graph
At most 6 items
5 fields of nodes
At most 40 characters
One of: trigger.webhook, trigger.audit_finished, action.run_audit, action.send_webhook
Position on the canvas.
`siteId` on `action.run_audit` and `trigger.audit_finished`; `url` (https, public) on `action.send_webhook`.
2 fields of config
2 fields of edges
The incoming webhook address. Present only when it was just created or replaced.
The first characters of the incoming token.
Verifies `Metricevo-Signature` on outgoing webhooks (HMAC-SHA256 of `t.body`).
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
Parameters
Responses
Events, newest first
1 field
6 fields of data
One of: triggered, delivered, delivery_failed
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
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
Responses
Accepted
3 fields
One of: queued, running, succeeded, partial, failed
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.