Trigger action

Trigger a one-off action and return the run that tracks it. The run is returned with status ongoing; the action itself is carried out asynchronously. Find available actions and their payload schemas with the actions endpoint.

POST

/v1/action-runs

POST

/action-runs

curl -X POST "https://api.corma.io/v1/action-runs" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "actionIdentifier": "string",
  "payload": {
    "key": null
  }
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

actionIdentifier
string
required
The identifier of the action to trigger. Query the actions endpoint to get the list of available actions.
payload
map of any
required
The payload the action is triggered with. Must conform to the payloadSchema returned by actions for the chosen action.
connectorId
string
The connector the action runs on: an identifier connectors returns, or the id of its connection. It must connect the integration of the action. Omitted, the action runs on the only connector of that integration.

Response

application/json202

id
integer
required
Identifies the run. Pass it as actionRunId to fetch this run again.
status
enum<string>
required
One of:
ongoing
completed
errored
source
enum<string>
required
What triggered the run. public_api is a run this API triggered; the log also covers runs triggered from the web app.
One of:
public_api
web_app
copilot
actionIdentifier
string
required
The action that was triggered.
payload
map of any
required
The payload the run was triggered with.
errorMessage
string | null
required
triggeredBy
UserEmbed | null
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": -9007199254740991,
  "status": "ongoing",
  "source": "public_api",
  "actionIdentifier": "string",
  "payload": {
    "key": null
  },
  "errorMessage": "string",
  "triggeredBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

POST

/action-runs

curl -X POST "https://api.corma.io/v1/action-runs" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "actionIdentifier": "string",
  "payload": {
    "key": null
  }
}'

{
  "id": -9007199254740991,
  "status": "ongoing",
  "source": "public_api",
  "actionIdentifier": "string",
  "payload": {
    "key": null
  },
  "errorMessage": "string",
  "triggeredBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

Trigger action - Corma Help Center | Productlane

API referenceAction runs

Trigger action

POST

/v1/action-runs

POST

/action-runs

curl -X POST "https://api.corma.io/v1/action-runs" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "actionIdentifier": "string",
  "payload": {
    "key": null
  }
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

actionIdentifier
string
required
The identifier of the action to trigger. Query the actions endpoint to get the list of available actions.
payload
map of any
required
The payload the action is triggered with. Must conform to the payloadSchema returned by actions for the chosen action.
connectorId
string
The connector the action runs on: an identifier connectors returns, or the id of its connection. It must connect the integration of the action. Omitted, the action runs on the only connector of that integration.

Response

application/json202

id
integer
required
Identifies the run. Pass it as actionRunId to fetch this run again.
status
enum<string>
required
One of:
ongoing
completed
errored
source
enum<string>
required
What triggered the run. public_api is a run this API triggered; the log also covers runs triggered from the web app.
One of:
public_api
web_app
copilot
actionIdentifier
string
required
The action that was triggered.
payload
map of any
required
The payload the run was triggered with.
errorMessage
string | null
required
triggeredBy
UserEmbed | null
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": -9007199254740991,
  "status": "ongoing",
  "source": "public_api",
  "actionIdentifier": "string",
  "payload": {
    "key": null
  },
  "errorMessage": "string",
  "triggeredBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

POST

/action-runs

curl -X POST "https://api.corma.io/v1/action-runs" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "actionIdentifier": "string",
  "payload": {
    "key": null
  }
}'

{
  "id": -9007199254740991,
  "status": "ongoing",
  "source": "public_api",
  "actionIdentifier": "string",
  "payload": {
    "key": null
  },
  "errorMessage": "string",
  "triggeredBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}