Test Metronome trigger
POST
/v1/metronomes/{metronomeId}/triggers/testSubmit a sample trigger payload, record a matched trigger diagnostic, and start a workflow run.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| metronomeId | path | string | Yes | Metronome workflow ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| triggerType | string | No | — |
| payload | object | No | — |
| definition | object | No | — |
| definition.nodes | object[] | No | — |
| definition.nodes[].id | string | No | Unique identifier. |
| definition.nodes[].type | string | No | — |
| definition.nodes[].position | object | No | — |
| definition.nodes[].data | object | No | — |
| definition.nodes[].data.kind | trigger | condition | action | imagine | function | database | ticket | metronome | loop | end | note | No | — |
| definition.nodes[].data.subtype | string | No | — |
| definition.nodes[].data.label | string | No | — |
| definition.nodes[].data.description | string | No | Human-readable description. |
| definition.nodes[].data.config | object | No | — |
| definition.edges | object[] | No | — |
| definition.edges[].id | string | No | Unique identifier. |
| definition.edges[].source | string | No | — |
| definition.edges[].target | string | No | — |
| definition.edges[].sourceHandle | string | No | — |
| definition.edges[].targetHandle | string | No | — |
| definition.edges[].label | string | No | — |
| idempotencyKey | string | No | — |
| maxAttempts | integer | No | — |
| timeoutMs | integer | No | — |
| attachedProjectId | string | No | — |
| attachedTicketId | string | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Metronome trigger test startedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| object | string | No | — |
| data | object | No | — |
| data.run | object | No | — |
| data.run.id | string | No | Unique identifier. |
| data.run.metronomeId | string | No | — |
| data.run.userId | string | No | User ID. |
| data.run.triggerType | string | No | — |
| data.run.versionId | string | No | — |
| data.run.triggerEventId | string | No | — |
| data.run.idempotencyKey | string | No | — |
| data.run.status | queued | running | waiting_approval | paused | completed | failed | cancelled | No | Current lifecycle status. |
| data.run.input | object | No | — |
| data.run.output | object | No | — |
| data.run.error | string | No | — |
| data.run.startedAt | string | No | ISO 8601 timestamp. |
| data.run.queuedAt | string | No | — |
| data.run.nextAttemptAt | string | No | — |
| data.run.lockedAt | string | No | — |
| data.run.lockedBy | string | No | — |
| data.run.attemptCount | integer | No | — |
| data.run.maxAttempts | integer | No | — |
| data.run.timeoutMs | integer | No | — |
| data.run.attachedProjectId | string | No | — |
| data.run.attachedTicketId | string | No | — |
| data.run.completedAt | string | No | ISO 8601 timestamp. |
| data.run.createdAt | string | No | ISO 8601 timestamp. |
| data.run.updatedAt | string | No | ISO 8601 timestamp. |
| data.triggerEventId | string | No | — |