OCocoya
Workflows

List information about the workflow

Changed on

Returns the workflow and its steps in order — each with its position (0 is the trigger), type (e.g. trigger-rss, generate-text, post-to-facebook), name, the channel it acts on, and its options.

get/workflow/{workflowId}

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Path parameters

workflowIdstring required
Example:cmajvvb9q0003ja5vh0538j6r

Ocoya workflow ID.

Response

Success

idstring required

Workflow ID.

createdAtstring required

When the workflow was created.

namestring nullable required

Workflow name.

onboolean required

Whether the workflow is turned on.

Example response

{
  "id": "cmajvvb9q0003ja5vh0538j6r",
  "createdAt": "2024-01-01T00:00:00Z",
  "name": "RSS to LinkedIn",
  "on": true,
  "steps": [
    {
      "id": "cmajvvbcc0005ja5v8f0d2k3m",
      "type": "trigger-rss",
      "name": "RSS feed",
      "channel": {
        "id": "clh49poxf008x8kov4ncbjty9",
        "name": "Ocoya",
        "provider": "linkedin"
      },
      "options": {
        "url": "https://example.com/feed.xml"
      }
    }
  ]
}

Changes

  • ef9bd3530850Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

      added the required property // to the response with the status

  • ad0d7f3cdd9bRevision changes
    • info

      api operation id getWorkflow was added

    • info

      api tag Workflows added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status