Appearance
linkedin.ads.conversion.rule.create ​
Create a LinkedIn Conversions API rule (POST /rest/conversions) for a pinned ad account. Does not stream events and does not enable spend.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-linkedin-ads |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | Parent DAG workflow run id (engine-injected when used as a step) |
organization_uuid | string | Yes | — | — |
connection_uuid | string | Yes | — | — |
ad_account_id | string | No | — | — |
name | string | Yes | — | Conversion rule display name |
conversion_type | string | Yes | — | LEAD, PURCHASE, SIGN_UP, KEY_PAGE_VIEW, … |
auto_associate_all_campaigns | boolean | No | — | When true, pass autoAssociationType=ALL_CAMPAIGNS |
post_click_window_days | integer | No | — | — |
view_through_window_days | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | Parent DAG workflow run id (engine-injected when used as a step) |
organization_uuid | string | Yes | — | — |
connection_uuid | string | Yes | — | — |
ad_account_id | string | No | — | — |
name | string | Yes | — | Conversion rule display name |
conversion_type | string | Yes | — | LEAD, PURCHASE, SIGN_UP, KEY_PAGE_VIEW, … |
auto_associate_all_campaigns | boolean | No | — | When true, pass autoAssociationType=ALL_CAMPAIGNS |
post_click_window_days | integer | No | — | — |
view_through_window_days | integer | No | — | — |
conversion_id | string | No | — | — |
conversion_urn | string | No | — | — |
raw | json | No | — | — |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at | string | No | — | ISO timestamp when the workflow failed |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
completed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
completed | SUCCESS | LinkedIn Ads atom completed successfully | completed_at |
failed | FAILURE | LinkedIn Ads atom failed | failure_reason, error, error_type |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "linkedin.ads.conversion.rule.create",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"name": "value",
"conversion_type": "value"
}
}