Invoke Metronome function trigger
POST
/v1/metronomes/{metronomeId}/triggers/function/{slug}Invoke a published Metronome function trigger with a JSON payload and queue 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 |
| slug | path | string | Yes | Function trigger slug configured on the workflow trigger node. |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| payload | object | No | — |
| sourceEventId | 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.
202Metronome function-trigger run queuedapplication/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.organizationId | string | No | — |
| data.run.createdByUserId | string | No | — |
| data.run.triggerType | string | No | — |
| data.run.versionId | string | No | — |
| data.run.snapshotId | string | No | Snapshot ID. |
| data.run.runKind | workflow | node_test | slice_test | No | — |
| data.run.invocationSource | string | No | — |
| data.run.executionSelection | object | No | — |
| data.run.effectMode | execute | preview | No | — |
| data.run.initiatedByUserId | string | No | — |
| data.run.requestFingerprint | 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.run.approvals | object[] | No | — |
| data.run.approvals[].id | string | Yes | Unique identifier. |
| data.run.approvals[].runId | string | Yes | — |
| data.run.approvals[].metronomeId | string | Yes | — |
| data.run.approvals[].nodeId | string | Yes | — |
| data.run.approvals[].approverUserId | string | Yes | — |
| data.run.approvals[].organizationId | string | No | — |
| data.run.approvals[].createdByUserId | string | No | — |
| data.run.approvals[].status | pending | approved | rejected | cancelled | Yes | Current lifecycle status. |
| data.run.approvals[].message | string | Yes | Message text. |
| data.run.approvals[].decisionByUserId | string | No | — |
| data.run.approvals[].decidedAt | string | No | — |
| data.run.approvals[].createdAt | string | No | ISO 8601 timestamp. |
| data.run.approvals[].updatedAt | string | No | ISO 8601 timestamp. |
| data.triggerEventId | string | No | — |
Invoke Metronome function trigger
Loading...
Response 202
Loading...