List the compositions a workflow can show, and what each can do

The workspace’s compositions as the workflow editor offers them, newest first. For each one: whether it can be shown (its widget has a published version), the websites it may be embedded on, and which triggers it supports.

• Input added (inputs) is enabled only for a composition that declares at least one table a visitor’s entries can be written to. Its tables are all of them; its fields are the columns a rule may read (not id and created_at, not a column that is not text, a number or yes/no, and not one whose name says it holds a person’s private details, such as an email or a phone number).
• Action in the widget (actions) is enabled only when the published widget version declares at least one goal. Its items are the goals a trigger can wait for.

When one of them is not enabled, reason says why (widget_keeps_no_data, widget_reports_no_actions or widget_not_published), so the editor can show the trigger disabled with an explanation. Publishing checks every reference again against what the composition can do at that moment. For personal workspace, use ‘personal’ as workspaceId. For organization workspace, use the organization UUID as workspaceId. Any active member can read it.

GET /workspaces/{workspaceId}/workflows/composition-options

List the compositions a workflow can show, and what each can do

cURL

curl --request GET \
  --url https://api.widgetic.com/v1/workspaces/{workspaceId}/workflows/composition-options \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": {
    "items": [
      "Example WorkflowCompositionOption"
    ],
    "total": 42,
    "limit": 42,
    "offset": 42
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Managed-User-Id · string<uuid>

The id Widgetic gave the managed user (POST /managed-users). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers 404 (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers 404 with MANAGED_USER_NOT_FOUND. An empty, repeated or malformed header is 400 with MANAGED_USER_SCOPE_INVALID; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with 403 and MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An Idempotency-Key is kept apart for each managed user.

Example:

"3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90"

X-Managed-User-External-Id · string

Your own id for the managed user (its externalId), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers 404 (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers 404 with MANAGED_USER_NOT_FOUND. An empty, repeated or malformed header is 400 with MANAGED_USER_SCOPE_INVALID; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with 403 and MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An Idempotency-Key is kept apart for each managed user.

Required string length: 1 - 255

Example:

"customer-1042"

Path Parameters

workspaceId · string · required

The workspace: 'personal' for your own workspace, or the UUID of an organization. A call made for one of your managed users (X-Managed-User-Id) always uses 'personal': a managed user has no other workspace, and a call that names an organization is refused with 403.

Query Parameters

search · string

Text the composition's name must contain

Maximum string length: 120

ids · string

Only these compositions (comma-separated ids, at most 50), those of them you may see. Ask for the compositions a workflow shows with this, so each is found whatever page it would be on. An id you may not see is left out, as one that does not exist is.

limit · integer

Page size (1-100, 50 when not given)

offset · integer

How many to skip (0 when not given)

Response

200

application/json

The compositions the editor can offer

success · boolean · required

Example:

true

data · object · required

Show child attributes

Example:

{
  "items": ["Example WorkflowCompositionOption"],
  "total": 42,
  "limit": 42,
  "offset": 42
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes