PApaymongo
Workflows

Validate Workflow Definition

Validates a workflow YAML definition against the workflow schema without storing anything

post/v1/workflows/validate

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows/validate
  • Auth
    none required

Headers

Organization-Idstring required

Organization ID

Request body text/plain

string required

Response

Workflow is valid

has_moreboolean

HasMore is true when more results exist beyond this page: after the last row when paging forward, before the first row when paging backward with before_id. It is a pointer so a non-paginated response omits the field rather than asserting false.

metaunknown
next_cursorstring

Opaque cursor for the last row on the page. Echo it as after_id to read the next page. It normally carries the sort it was issued under, so sort_by need not be repeated; for a very long text sort value the API falls back to a plain row id, which carries no sort, so a client pinning a non-default sort should keep sending sort_by. It sits beside has_more rather than inside meta, and is omitted when the page has no rows.

prev_cursorstring

Opaque cursor for the first row on the page. Echo it as before_id to read the previous page. It normally carries the sort it was issued under, so sort_by need not be repeated; for a very long text sort value the API falls back to a plain row id, which carries no sort, so a client pinning a non-default sort should keep sending sort_by. It sits beside has_more rather than inside meta, and is omitted when the page has no rows.

Example response

{
  "data": {
    "description": "Workflow description",
    "name": "workflow-name",
    "valid": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.