V2 Automations

List automation connections (v2)

get

Returns stored workspace connections. Secret values are never returned.

Responses

200

Automation connections retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

typestringOptional

scopestringOptional

activebooleanOptional

401

Unauthorized

application/json

get

/api/v2/automation-connections

HTTPcURLJavaScriptPython

GET /api/v2/automation-connections HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "text",
    "scope": "text",
    "active": true,
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Create automation connection (v2)

post

Creates one stored workspace connection for http_request actions. Secret values are write-only.

Body

application/json

namestringOptional

typestringOptional

scopestringOptional

ownerMemberIdstring · uuidOptional

activebooleanOptional

Responses

201

Automation connection created successfully

application/json

400

Invalid connection payload

application/json

401

Unauthorized

application/json

post

/api/v2/automation-connections

HTTPcURLJavaScriptPython

POST /api/v2/automation-connections HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "name": "ERP API Key",
  "type": "api_key",
  "scope": "workspace",
  "config": {
    "headerName": "Authorization"
  },
  "secret": {
    "apiKey": "super-secret"
  },
  "active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "type": "text",
  "scope": "text",
  "ownerMemberId": "123e4567-e89b-12d3-a456-426614174000",
  "active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2026-03-23T19:47:33.367Z",
  "updatedAt": "2026-03-23T19:47:33.367Z",
  "createdBy": "text",
  "updatedBy": "text"
}

Get automation connection (v2)

get

Returns one stored connection. Secret values are never returned.

Responses

200

Automation connection retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

typestringOptional

scopestringOptional

ownerMemberIdstring · uuidOptional

activebooleanOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

createdBystringOptional

updatedBystringOptional

401

Unauthorized

application/json

404

Connection not found

application/json

get

/api/v2/automation-connections/{connectionId}

HTTPcURLJavaScriptPython

GET /api/v2/automation-connections/{connectionId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "type": "text",
  "scope": "text",
  "ownerMemberId": "123e4567-e89b-12d3-a456-426614174000",
  "active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2026-03-23T19:47:33.367Z",
  "updatedAt": "2026-03-23T19:47:33.367Z",
  "createdBy": "text",
  "updatedBy": "text"
}

Delete automation connection (v2)

delete

Deletes one stored connection.

Responses

200

Automation connection deleted successfully

application/json

anyOptional

401

Unauthorized

application/json

404

Connection not found

application/json

delete

/api/v2/automation-connections/{connectionId}

HTTPcURLJavaScriptPython

DELETE /api/v2/automation-connections/{connectionId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

No content

Patch automation connection (v2)

patch

Patches one stored connection. Use set.secret only when rotating secrets.

Body

application/json

unsetstring[]Optional

Responses

200

Automation connection patched successfully

application/json

idstring · uuidOptional

namestringOptional

typestringOptional

scopestringOptional

ownerMemberIdstring · uuidOptional

activebooleanOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

createdBystringOptional

updatedBystringOptional

400

Invalid connection patch payload

application/json

401

Unauthorized

application/json

404

Connection not found

application/json

patch

/api/v2/automation-connections/{connectionId}

HTTPcURLJavaScriptPython

PATCH /api/v2/automation-connections/{connectionId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "set": {
    "name": "ERP API Key Updated",
    "config": {
      "headerName": "Authorization"
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "type": "text",
  "scope": "text",
  "ownerMemberId": "123e4567-e89b-12d3-a456-426614174000",
  "active": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2026-03-23T19:47:33.367Z",
  "updatedAt": "2026-03-23T19:47:33.367Z",
  "createdBy": "text",
  "updatedBy": "text"
}

List automation folders (v2)

get

Returns the flat public folder projection over legacy workflow groups.

Responses

200

Automation folders retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

isRootbooleanOptional

automationCountinteger · int32Optional

401

Unauthorized

application/json

get

/api/v2/automation-folders

HTTPcURLJavaScriptPython

GET /api/v2/automation-folders HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "cdfc14e3-3169-4ffb-8d9b-b11858a9240f",
    "name": "Codex Frontend Demo",
    "isRoot": false,
    "automationCount": 2
  },
  {
    "id": "8b22282b-3db3-4dd7-87f7-b29365dcf3f6",
    "name": null,
    "isRoot": true,
    "automationCount": 3
  }
]

Create automation folder (v2)

post

Creates one flat automation folder.

Body

application/json

namestringOptional

Responses

201

Automation folder created successfully

application/json

400

Invalid automation folder payload

application/json

401

Unauthorized

application/json

post

/api/v2/automation-folders

HTTPcURLJavaScriptPython

POST /api/v2/automation-folders HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "Codex Frontend Demo"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isRoot": true,
  "automationCount": 1
}

Delete automation folder (v2)

delete

Deletes one non-root automation folder.

Responses

200

Automation folder deleted successfully

application/json

idstring · uuidOptional

namestringOptional

isRootbooleanOptional

automationCountinteger · int32Optional

400

Invalid delete request

application/json

401

Unauthorized

application/json

404

Folder not found

application/json

delete

/api/v2/automation-folders/{folderId}

HTTPcURLJavaScriptPython

DELETE /api/v2/automation-folders/{folderId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isRoot": true,
  "automationCount": 1
}

Patch automation folder (v2)

patch

Renames one automation folder.

Body

application/json

namestringOptional

Responses

200

Automation folder patched successfully

application/json

idstring · uuidOptional

namestringOptional

isRootbooleanOptional

automationCountinteger · int32Optional

400

Invalid folder patch payload

application/json

401

Unauthorized

application/json

404

Folder not found

application/json

patch

/api/v2/automation-folders/{folderId}

HTTPcURLJavaScriptPython

PATCH /api/v2/automation-folders/{folderId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "name": "Codex Frontend Demo Updated"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isRoot": true,
  "automationCount": 1
}

Move automation to folder (v2)

post

Moves one automation into a target flat folder.

Body

application/json

automationIdstring · uuidOptional

Responses

200

Automation moved successfully

application/json

idstring · uuidOptional

namestringOptional

isRootbooleanOptional

400

Invalid move payload

application/json

401

Unauthorized

application/json

404

Folder or automation not found

application/json

post

/api/v2/automation-folders/{folderId}/automations:move

HTTPcURLJavaScriptPython

POST /api/v2/automation-folders/{folderId}/automations:move HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "automationId": "d2df2478-2513-4ecb-a2aa-2cea8c3d614a"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isRoot": true
}

List automation plugins (v2)

get

Returns active workspace plugins available for execute_plugin actions.

Responses

200

Automation plugins retrieved successfully

application/json

idstringOptional

namestringOptional

activebooleanOptional

descriptionstringOptional

401

Unauthorized

application/json

get

/api/v2/automation-plugins

HTTPcURLJavaScriptPython

GET /api/v2/automation-plugins HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "active": true,
    "description": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Get automation plugin (v2)

get

Returns one active workspace plugin by id.

Responses

200

Automation plugin retrieved successfully

application/json

idstringOptional

namestringOptional

activebooleanOptional

descriptionstringOptional

401

Unauthorized

application/json

404

Plugin not found

application/json

get

/api/v2/automation-plugins/{pluginId}

HTTPcURLJavaScriptPython

GET /api/v2/automation-plugins/{pluginId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "text",
  "name": "text",
  "active": true,
  "description": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

List automations (v2)

get

Returns automation summaries with optional filters by folder, status, trigger type, action type, plugin, and search.

Responses

200

Automation list retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

statusstringOptional

triggerTypestringOptional

actionTypesstring[]Optional

401

Unauthorized

application/json

get

/api/v2/automations

HTTPcURLJavaScriptPython

GET /api/v2/automations HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "d2df2478-2513-4ecb-a2aa-2cea8c3d614a",
    "name": "Codex Trigger Demo 1774278580",
    "description": "Demo compleja no-webhook para revisar en frontend.",
    "status": "active",
    "folder": {
      "id": "cdfc14e3-3169-4ffb-8d9b-b11858a9240f",
      "name": "Codex Frontend Demo",
      "isRoot": false
    },
    "triggerType": "record_changed",
    "actionTypes": [
      "create_record",
      "http_request",
      "execute_plugin",
      "send_message"
    ]
  }
]

Create automation (v2)

post

Creates one automation. Agents should provide a complete trigger and a frontend-meaningful configuration, not just a minimally valid payload.

Body

application/json

namestringOptional

descriptionstringOptional

folderIdstring · uuidOptional

Responses

201

Automation created successfully

application/json

400

Invalid automation payload

application/json

401

Unauthorized

application/json

post

/api/v2/automations

HTTPcURLJavaScriptPython

POST /api/v2/automations HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "name": "Nightly invoice sync",
  "description": "Runs every Monday morning",
  "folderId": "cdfc14e3-3169-4ffb-8d9b-b11858a9240f",
  "trigger": {
    "type": "scheduled",
    "config": {
      "cronExpression": "0 15 10 * * 1"
    }
  }
}

Scheduled demoRecord changed

{
  "automationId": "123e4567-e89b-12d3-a456-426614174000"
}

Get automation (v2)

get

Returns the full public automation document including trigger, actions, and flow.

Responses

200

Automation retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

statusstringOptional

401

Unauthorized

application/json

404

Automation not found

application/json

get

/api/v2/automations/{automationId}

HTTPcURLJavaScriptPython

GET /api/v2/automations/{automationId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "text",
  "folder": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "isRoot": true
  },
  "trigger": {
    "type": "text",
    "config": {
      "type": "text",
      "schemaId": "123e4567-e89b-12d3-a456-426614174000",
      "fieldIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "conditions": [
        {
          "field": "123e4567-e89b-12d3-a456-426614174000",
          "comparator": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  },
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "config": {
        "type": "text",
        "targetSchemaId": "123e4567-e89b-12d3-a456-426614174000",
        "fieldMapping": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "flow": {
    "entryActionIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "transitions": [
      {
        "fromActionId": "123e4567-e89b-12d3-a456-426614174000",
        "toActionId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

Delete automation (v2)

delete

Deletes one automation.

Responses

200

Automation deleted successfully

application/json

automationIdstring · uuidOptional

401

Unauthorized

application/json

404

Automation not found

application/json

delete

/api/v2/automations/{automationId}

HTTPcURLJavaScriptPython

DELETE /api/v2/automations/{automationId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "automationId": "123e4567-e89b-12d3-a456-426614174000"
}

Patch automation metadata (v2)

patch

Updates only top-level metadata. Supported patch paths: name, description, folderId.

Body

application/json

unsetstring[]Optional

Responses

200

Automation patched successfully

application/json

anyOptional

400

Invalid patch payload

application/json

401

Unauthorized

application/json

404

Automation not found

application/json

patch

/api/v2/automations/{automationId}

HTTPcURLJavaScriptPython

PATCH /api/v2/automations/{automationId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "set": {
    "description": "Updated by an agent",
    "folderId": "cdfc14e3-3169-4ffb-8d9b-b11858a9240f"
  }
}

No content

List actions (v2)

get

Returns the ordered list of public actions for one automation.

Responses

200

Actions retrieved successfully

application/json

idstring · uuidOptional

typestringOptional

namestringOptional

configone ofOptional

or

or

or

or

or

401

Unauthorized

application/json

404

Automation not found

application/json

get

/api/v2/automations/{automationId}/actions

HTTPcURLJavaScriptPython

GET /api/v2/automations/{automationId}/actions HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "name": "text",
    "config": {
      "type": "text",
      "targetSchemaId": "123e4567-e89b-12d3-a456-426614174000",
      "fieldMapping": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
]

Add action (v2)

post

Adds one action. For record-based actions, populate visible fieldMapping so the frontend form is complete.

Body

application/json

typestringOptional

namestringOptional

configone ofOptional

or

or

or

or

or

Responses

201

Action created successfully

application/json

400

Invalid action payload

application/json

401

Unauthorized

application/json

404

Automation not found

application/json

post

/api/v2/automations/{automationId}/actions

HTTPcURLJavaScriptPython

POST /api/v2/automations/{automationId}/actions HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "type": "create_record",
  "name": "Create follow-up order",
  "config": {
    "targetSchemaId": "68d2c7be-4392-42de-b5ae-625ad79cfc3c",
    "fieldMapping": {
      "b013afec-21c8-4b0e-b3bf-5e4f7512e797": {
        "rawValue": "2026-03-24T09:00:00.000Z",
        "source": null
      },
      "34250412-f016-44c0-9f88-37dd1ddb4b13": {
        "rawValue": "Created by automation demo",
        "source": null
      }
    }
  }
}

Create recordHTTP request

No content

Update action (v2)

put

Replaces one action payload.

Body

application/json

typestringOptional

namestringOptional

configone ofOptional

or

or

or

or

or

Responses

200

Action updated successfully

application/json

idstring · uuidOptional

typestringOptional

namestringOptional

configone ofOptional

or

or

or

or

or

400

Invalid action payload

application/json

401

Unauthorized

application/json

404

Automation or action not found

application/json

put

/api/v2/automations/{automationId}/actions/{actionId}

HTTPcURLJavaScriptPython

PUT /api/v2/automations/{automationId}/actions/{actionId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "type": "create_record",
  "name": "Create follow-up order",
  "config": {
    "targetSchemaId": "68d2c7be-4392-42de-b5ae-625ad79cfc3c",
    "fieldMapping": {
      "34250412-f016-44c0-9f88-37dd1ddb4b13": {
        "rawValue": "Updated by an agent",
        "source": null
      }
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "name": "text",
  "config": {
    "type": "text",
    "targetSchemaId": "123e4567-e89b-12d3-a456-426614174000",
    "fieldMapping": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Delete action (v2)

delete

Deletes one action from the automation.

Responses

200

Action deleted successfully

application/json

automationIdstring · uuidOptional

401

Unauthorized

application/json

404

Automation or action not found

application/json

delete

/api/v2/automations/{automationId}/actions/{actionId}

HTTPcURLJavaScriptPython

DELETE /api/v2/automations/{automationId}/actions/{actionId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "automationId": "123e4567-e89b-12d3-a456-426614174000"
}

Get flow (v2)

get

Returns the public flow subresource.

Responses

200

Flow retrieved successfully

application/json

entryActionIdsstring · uuid[]Optional

401

Unauthorized

application/json

404

Automation not found

application/json

get

/api/v2/automations/{automationId}/flow

HTTPcURLJavaScriptPython

GET /api/v2/automations/{automationId}/flow HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "entryActionIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "transitions": [
    {
      "fromActionId": "123e4567-e89b-12d3-a456-426614174000",
      "toActionId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Replace flow (v2)

put

Replaces entry actions and transitions for the automation.

Body

application/json

entryActionIdsstring · uuid[]Optional

Responses

200

Flow replaced successfully

application/json

anyOptional

400

Invalid flow payload

application/json

401

Unauthorized

application/json

404

Automation not found

application/json

put

/api/v2/automations/{automationId}/flow

HTTPcURLJavaScriptPython

PUT /api/v2/automations/{automationId}/flow HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "entryActionIds": [
    "a657c49a-8ca1-4ec1-af86-d0dac4fc49b2"
  ],
  "transitions": [
    {
      "fromActionId": "a657c49a-8ca1-4ec1-af86-d0dac4fc49b2",
      "toActionId": "784d0971-bd8f-4b05-87eb-3392d1570273"
    },
    {
      "fromActionId": "784d0971-bd8f-4b05-87eb-3392d1570273",
      "toActionId": "dae13307-057f-4c39-817c-4d2dd5898421"
    }
  ]
}

No content

Get trigger (v2)

get

Returns the public trigger subresource.

Responses

200

Trigger retrieved successfully

application/json

typestringOptional

configone ofOptional

or

or

or

401

Unauthorized

application/json

404

Automation not found

application/json

get

/api/v2/automations/{automationId}/trigger

HTTPcURLJavaScriptPython

GET /api/v2/automations/{automationId}/trigger HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "type": "text",
  "config": {
    "type": "text",
    "schemaId": "123e4567-e89b-12d3-a456-426614174000",
    "fieldIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "conditions": [
      {
        "field": "123e4567-e89b-12d3-a456-426614174000",
        "comparator": "text",
        "values": [
          "text"
        ]
      }
    ]
  }
}

Replace trigger (v2)

put

Replaces the automation trigger. For record_created and record_changed, agents should provide at least one meaningful condition for frontend-complete workflows.

Body

application/json

typestringOptional

configone ofOptional

or

or

or

Responses

200

Trigger replaced successfully

application/json

anyOptional

400

Invalid trigger payload

application/json

401

Unauthorized

application/json

404

Automation not found

application/json

put

/api/v2/automations/{automationId}/trigger

HTTPcURLJavaScriptPython

PUT /api/v2/automations/{automationId}/trigger HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "type": "record_changed",
  "config": {
    "schemaId": "68d2c7be-4392-42de-b5ae-625ad79cfc3c",
    "fieldIds": [
      "4dd04e57-2a01-4c49-8728-9cb288bffb8d"
    ],
    "conditions": [
      {
        "field": "4dd04e57-2a01-4c49-8728-9cb288bffb8d",
        "comparator": "ine",
        "values": [
          ""
        ]
      }
    ]
  }
}

Record changedWebhook

No content

Get webhook endpoint (v2)

get

Returns the webhook endpoint companion resource for an automation.

Responses

200

Webhook endpoint retrieved successfully

application/json

endpointIdstring · uuidOptional

automationIdstring · uuidOptional

endpointUrlstringOptional

activebooleanOptional

idempotencyKeyJsonPathstringOptional

eventTypeJsonPathstringOptional

allowedEventTypesstring[]Optional

401

Unauthorized

application/json

404

Automation or webhook endpoint not found

application/json

get

/api/v2/automations/{automationId}/webhook-endpoint

HTTPcURLJavaScriptPython

GET /api/v2/automations/{automationId}/webhook-endpoint HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "endpointId": "123e4567-e89b-12d3-a456-426614174000",
  "automationId": "123e4567-e89b-12d3-a456-426614174000",
  "endpointUrl": "text",
  "active": true,
  "idempotencyKeyJsonPath": "text",
  "eventTypeJsonPath": "text",
  "allowedEventTypes": [
    "text"
  ],
  "fieldMappings": [
    {
      "variable": "text",
      "jsonPath": "text"
    }
  ]
}

Create or update webhook endpoint (v2)

put

Creates or updates the webhook endpoint companion resource.

Body

application/json

idempotencyKeyJsonPathstringOptional

eventTypeJsonPathstringOptional

allowedEventTypesstring[]Optional

activebooleanOptional

Responses

200

Webhook endpoint saved successfully

application/json

endpointIdstring · uuidOptional

automationIdstring · uuidOptional

endpointUrlstringOptional

activebooleanOptional

idempotencyKeyJsonPathstringOptional

eventTypeJsonPathstringOptional

allowedEventTypesstring[]Optional

400

Invalid webhook endpoint payload

application/json

401

Unauthorized

application/json

404

Automation not found

application/json

put

/api/v2/automations/{automationId}/webhook-endpoint

HTTPcURLJavaScriptPython

PUT /api/v2/automations/{automationId}/webhook-endpoint HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "idempotencyKeyJsonPath": "$.id",
  "eventTypeJsonPath": "$.type",
  "allowedEventTypes": [
    "frontend.demo.created"
  ],
  "fieldMappings": [
    {
      "variable": "external_id",
      "jsonPath": "$.data.id"
    }
  ],
  "active": true
}

{
  "endpointId": "123e4567-e89b-12d3-a456-426614174000",
  "automationId": "123e4567-e89b-12d3-a456-426614174000",
  "endpointUrl": "text",
  "active": true,
  "idempotencyKeyJsonPath": "text",
  "eventTypeJsonPath": "text",
  "allowedEventTypes": [
    "text"
  ],
  "fieldMappings": [
    {
      "variable": "text",
      "jsonPath": "text"
    }
  ]
}

Delete webhook endpoint (v2)

delete

Deletes the webhook endpoint companion resource.

Responses

200

Webhook endpoint deleted successfully

application/json

anyOptional

401

Unauthorized

application/json

404

Automation or webhook endpoint not found

application/json

delete

/api/v2/automations/{automationId}/webhook-endpoint

HTTPcURLJavaScriptPython

DELETE /api/v2/automations/{automationId}/webhook-endpoint HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

No content

Activate automation (v2)

post

Transitions one automation to active.

Responses

200

Automation activated successfully

application/json

automationIdstring · uuidOptional

401

Unauthorized

application/json

404

Automation not found

application/json

post

/api/v2/automations/{automationId}:activate

HTTPcURLJavaScriptPython

POST /api/v2/automations/{automationId}:activate HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "automationId": "123e4567-e89b-12d3-a456-426614174000"
}

Deactivate automation (v2)

post

Transitions one automation to inactive.

Responses

200

Automation deactivated successfully

application/json

automationIdstring · uuidOptional

401

Unauthorized

application/json

404

Automation not found

application/json

post

/api/v2/automations/{automationId}:deactivate

HTTPcURLJavaScriptPython

POST /api/v2/automations/{automationId}:deactivate HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "automationId": "123e4567-e89b-12d3-a456-426614174000"
}