USuseboom
Journeys

Validate journey

Changed on

Dry-run the publish checks against a journey graph without saving. Pass a journeyId to validate the stored draft, or a definition to validate a graph as sent (exactly one of the two). Returns whether it is valid and the list of issues (errors block publishing; warnings are advisory). A node that sends a field the org marked hidden (sensitive) in a message, an HTTP request or a route-to-initiative mapping gets a SENSITIVE_FIELD_SENT, SENSITIVE_FIELD_SENT_EXTERNAL or SENSITIVE_FIELD_MAPPED warning naming the field; it never blocks. Use it to iterate a draft to valid before publishing in the app.

post/api/v1/journeys/validate

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Request body

journeyIdstring

Validate the stored draft: a draft journey id, or the initiative id (resolves to its current draft). Exactly one of journeyId or definition.

Response

Success

validboolean required

True when there are no error-severity issues.

Changes

  • 7c7a773b12ceRevision changes
    • breaking

      removed subschema #1 subschema #2 subschema #5 subschema #8 subschema #9 subschema #10 subschema #11 from the // request property oneOf list

    • info

      added the new optional request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #10 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 subschema #21 subschema #22 subschema #23 to the // request property oneOf list