> ## Documentation Index > Fetch the complete documentation index at: https://docs.amply-app.com/llms.txt > Use this file to discover all available pages before exploring further. # Update workflow resource ## OpenAPI ````yaml https://api.amply-app.com/v1/openapi.json patch /v1/users/{userId}/broadcasts/{broadcastId}/workflows/{workflowId} openapi: 3.1.0 info: title: Amply API version: 1.0.0 description: >- Authentication: send your API key in the `X-API-KEY` header. Each API key is tied to a single broadcast. A key cannot manage multiple broadcasts. API keys can be generated from the broadcast developer settings. servers: - url: https://api.amply-app.com security: - ApiKeyAuth: [] tags: - name: broadcastEvent resource description: API endpoints for managing broadcastEvent resources x-tag-schema: $ref: '#/components/schemas/broadcastEventResponse' x-tag-schema-example: type: app.opened metadata: {} _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastNetworkingForm resource description: API endpoints for managing broadcastNetworkingForm resources x-tag-schema: $ref: '#/components/schemas/broadcastNetworkingForm' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: media resource description: API endpoints for managing media resources x-tag-schema: $ref: '#/components/schemas/media' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _userId: string mediaUrl: string external: true _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastContact resource description: API endpoints for managing broadcastContact resources x-tag-schema: $ref: '#/components/schemas/broadcastContact' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastCategory resource description: API endpoints for managing broadcastCategory resources x-tag-schema: $ref: '#/components/schemas/broadcastCategory' x-tag-schema-example: status: draft _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastClient resource description: API endpoints for managing broadcastClient resources x-tag-schema: $ref: '#/components/schemas/broadcastClient' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastDiffuser resource description: API endpoints for managing broadcastDiffuser resources x-tag-schema: $ref: '#/components/schemas/broadcastDiffuser' x-tag-schema-example: type: webSite seo: title: string metaDescription: string indexing: true _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastCampaign resource description: API endpoints for managing broadcastCampaign resources x-tag-schema: $ref: '#/components/schemas/broadcastCampaign' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastArticle resource description: API endpoints for managing broadcastArticle resources x-tag-schema: $ref: '#/components/schemas/broadcastArticle' x-tag-schema-example: status: draft blocks: - type: media _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcast resource description: API endpoints for managing broadcast resources x-tag-schema: $ref: '#/components/schemas/broadcast' x-tag-schema-example: name: x _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastHost resource description: API endpoints for managing broadcastHost resources x-tag-schema: $ref: '#/components/schemas/broadcastHost' x-tag-schema-example: name: x status: draft _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastInterestPoint resource description: API endpoints for managing broadcastInterestPoint resources x-tag-schema: $ref: '#/components/schemas/broadcastInterestPoint' x-tag-schema-example: mapId: 64b7f8b6f23a4a4f3d0a9b12 status: draft _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastMap resource description: API endpoints for managing broadcastMap resources x-tag-schema: $ref: '#/components/schemas/broadcastMap' x-tag-schema-example: type: image status: draft metadata: {} - name: broadcastMember resource description: API endpoints for managing broadcastMember resources x-tag-schema: $ref: '#/components/schemas/broadcastMember' x-tag-schema-example: email: user@example.com _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastPage resource description: API endpoints for managing broadcastPage resources x-tag-schema: $ref: '#/components/schemas/broadcastPage' x-tag-schema-example: status: draft blocks: - type: media _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: revision resource description: API endpoints for managing revision resources x-tag-schema: $ref: '#/components/schemas/revision' x-tag-schema-example: tos: accepted: true _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastSession resource description: API endpoints for managing broadcastSession resources x-tag-schema: $ref: '#/components/schemas/broadcastSession' x-tag-schema-example: status: draft time: {} blocks: - type: media _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: workflow resource description: API endpoints for managing workflow resources x-tag-schema: $ref: '#/components/schemas/workflow' x-tag-schema-example: entryNodeId: x nodes: - id: x position: - 0 - 0 type: amply config: operation: type: string value: string resource: type: string value: string name: x _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: workflowRun resource description: API endpoints for managing workflowRun resources x-tag-schema: $ref: '#/components/schemas/workflowRun' x-tag-schema-example: status: running durationMs: 0 invokedNodeCount: 0 context: {} nodeResults: - executionId: x index: 0 nodeId: x nodeType: amply routeTaken: onSuccess durationMs: 0 _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: font resource description: API endpoints for managing font resources x-tag-schema: $ref: '#/components/schemas/font' x-tag-schema-example: fontFamily: string weights: - weight: 0 url: https://example.com _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' paths: /v1/users/{userId}/broadcasts/{broadcastId}/workflows/{workflowId}: patch: tags: - workflow resource summary: Update workflow resource parameters: - name: userId in: path required: true description: Resource identifier. schema: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 - name: broadcastId in: path required: true description: Resource identifier. schema: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 - name: workflowId in: path required: true description: Resource identifier. schema: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workflowUpdate' example: entryNodeId: x responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/workflow' components: schemas: workflowUpdate: type: object properties: entryNodeId: type: string minLength: 1 example: x nodes: type: array items: oneOf: - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - amply example: amply config: type: object properties: operation: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string resource: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string id: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string metadata: description: Hicards metadata payload type: object properties: filters: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object filtersLogical: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - $and - $or - $nor example: $and useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value preview: type: boolean example: true cursors: type: object properties: limit: type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value skip: type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value startId: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string sort: type: object additionalProperties: type: string enum: - asc - desc example: asc required: - limit - skip - sort required: - filters - filtersLogical - preview - cursors body: anyOf: - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string required: - operation - resource required: - id - position - type - config title: amply - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - http example: http config: type: object properties: url: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string method: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - GET - POST - PUT - PATCH - DELETE example: GET useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value responseFormat: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - json - text example: json useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value headers: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object query: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object body: anyOf: - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string timeoutMs: type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value required: - url required: - id - position - type - config title: http - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - foreach example: foreach config: type: object properties: from: type: object properties: type: type: string enum: - array example: array value: type: array items: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array onLoop: type: string minLength: 1 example: x failOnItemError: type: boolean example: true required: - from - onLoop required: - id - position - type - config title: foreach - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - auth example: auth config: default: {} type: object properties: authData: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value required: - id - position - type title: auth - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - if example: if config: default: {} type: object properties: logical: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - '&&' - '||' example: '&&' useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value conditions: type: array items: type: object properties: left: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array operator: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - eq - neq - gt - gte - lt - lte - includes - notIncludes - exists - notExists example: eq useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value right: allOf: - oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - left - operator required: - id - position - type title: if - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - code example: code config: type: object properties: code: type: string minLength: 1 description: >- JavaScript à exécuter. Le code doit retourner une valeur (return direct, expression, ou IIFE). Variables disponibles: $context, $nodeResults, $prevNodeResult. $context = données statiques du run (workflow complet, user complet, broadcast complet) + startedAt + workflowRunId. $nodeResults = historique des exécutions par node (indexé par node.id, avec un tableau d'entrées). Exemple: "(() => ({ currentItem: $nodeResults.forEachAttendees?.at(-1)?.output, previous: $nodeResults.fetchUsers?.at(-1)?.output, workflowName: $context.workflow.name, workflowRunId: $context.workflowRunId }))()". example: x timeoutMs: type: integer exclusiveMinimum: true maximum: 9007199254740991 example: 0 required: - code required: - id - position - type - config title: code description: >- Définition des nodes du workflow. Chaque node possède: id, position [x,y], type, config, onSuccess, onError. Les variables runtime des code nodes sont documentées dans config.code. name: type: string minLength: 1 example: x description: type: string example: string status: type: string enum: - enabled - disabled example: enabled trigger: oneOf: - type: object properties: type: type: string enum: - manual description: >- Le workflow ne se déclenche que manuellement via l'API ou l'interface d'administration. example: manual required: - type title: manual - type: object properties: type: type: string enum: - interval description: Le workflow se déclenche à intervalles réguliers. example: interval interval: type: string minLength: 1 description: 'Durée ISO 8601 (ex: PT15M).' example: x startsAt: {} endsAt: {} required: - type - interval title: interval - type: object properties: type: type: string enum: - schedule description: Le workflow se déclenche selon un horaire défini. example: schedule durations: minItems: 1 type: array items: type: string minLength: 1 example: x description: 'Moments de la journée en durée ISO 8601 (ex: PT8H30M).' startsAt: {} endsAt: {} required: - type - durations title: schedule - type: object properties: type: type: string enum: - once description: Le workflow se déclenche une seule fois à un moment précis. example: once runAt: description: Date et heure du déclenchement du workflow. required: - type - runAt title: once metadata: type: object additionalProperties: {} workflow: type: object properties: entryNodeId: type: string minLength: 1 example: x nodes: type: array items: oneOf: - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - amply example: amply config: type: object properties: operation: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string resource: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string id: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string metadata: description: Hicards metadata payload type: object properties: filters: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object filtersLogical: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - $and - $or - $nor example: $and useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value preview: type: boolean example: true cursors: type: object properties: limit: type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value skip: type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value startId: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string sort: type: object additionalProperties: type: string enum: - asc - desc example: asc required: - limit - skip - sort required: - filters - filtersLogical - preview - cursors body: anyOf: - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string required: - operation - resource required: - id - position - type - config title: amply - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - http example: http config: type: object properties: url: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string method: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - GET - POST - PUT - PATCH - DELETE example: GET useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value responseFormat: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - json - text example: json useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value headers: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object query: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object body: anyOf: - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string timeoutMs: type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value required: - url required: - id - position - type - config title: http - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - foreach example: foreach config: type: object properties: from: type: object properties: type: type: string enum: - array example: array value: type: array items: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array onLoop: type: string minLength: 1 example: x failOnItemError: type: boolean example: true required: - from - onLoop required: - id - position - type - config title: foreach - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - auth example: auth config: default: {} type: object properties: authData: type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string value: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value required: - id - position - type title: auth - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - if example: if config: default: {} type: object properties: logical: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - '&&' - '||' example: '&&' useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value conditions: type: array items: type: object properties: left: oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array operator: type: object properties: type: type: string enum: - enum example: enum value: type: string enum: - eq - neq - gt - gte - lt - lte - includes - notIncludes - exists - notExists example: eq useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value right: allOf: - oneOf: - type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: string - type: object properties: type: type: string enum: - number example: number value: type: number example: 0 useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: number - type: object properties: type: type: string enum: - boolean example: boolean value: type: boolean example: true useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: boolean - type: object properties: type: type: string enum: - object example: object value: type: array items: type: object properties: key: type: object properties: type: type: string enum: - string example: string value: type: string example: string useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value value: {} required: - key - value useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: object - type: object properties: type: type: string enum: - array example: array value: type: array items: {} useExpression: nullable: true type: boolean example: true expression: nullable: true type: string example: string required: - type - value title: array required: - left - operator required: - id - position - type title: if - type: object properties: id: type: string minLength: 1 example: x name: type: string minLength: 1 example: x position: type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 errorBehavior: default: stopWorkflow type: string enum: - stopWorkflow - continueWorkflow - passToErrorNode onSuccess: type: string minLength: 1 example: x onError: type: string minLength: 1 example: x type: type: string enum: - code example: code config: type: object properties: code: type: string minLength: 1 description: >- JavaScript à exécuter. Le code doit retourner une valeur (return direct, expression, ou IIFE). Variables disponibles: $context, $nodeResults, $prevNodeResult. $context = données statiques du run (workflow complet, user complet, broadcast complet) + startedAt + workflowRunId. $nodeResults = historique des exécutions par node (indexé par node.id, avec un tableau d'entrées). Exemple: "(() => ({ currentItem: $nodeResults.forEachAttendees?.at(-1)?.output, previous: $nodeResults.fetchUsers?.at(-1)?.output, workflowName: $context.workflow.name, workflowRunId: $context.workflowRunId }))()". example: x timeoutMs: type: integer exclusiveMinimum: true maximum: 9007199254740991 example: 0 required: - code required: - id - position - type - config title: code description: >- Définition des nodes du workflow. Chaque node possède: id, position [x,y], type, config, onSuccess, onError. Les variables runtime des code nodes sont documentées dans config.code. name: type: string minLength: 1 example: x description: type: string example: string status: type: string enum: - enabled - disabled example: enabled trigger: oneOf: - type: object properties: type: type: string enum: - manual description: >- Le workflow ne se déclenche que manuellement via l'API ou l'interface d'administration. example: manual required: - type title: manual - type: object properties: type: type: string enum: - interval description: Le workflow se déclenche à intervalles réguliers. example: interval interval: type: string minLength: 1 description: 'Durée ISO 8601 (ex: PT15M).' example: x startsAt: {} endsAt: {} required: - type - interval title: interval - type: object properties: type: type: string enum: - schedule description: Le workflow se déclenche selon un horaire défini. example: schedule durations: minItems: 1 type: array items: type: string minLength: 1 example: x description: 'Moments de la journée en durée ISO 8601 (ex: PT8H30M).' startsAt: {} endsAt: {} required: - type - durations title: schedule - type: object properties: type: type: string enum: - once description: Le workflow se déclenche une seule fois à un moment précis. example: once runAt: description: Date et heure du déclenchement du workflow. required: - type - runAt title: once metadata: type: object additionalProperties: {} _id: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: type: string format: date-time example: '2024-01-01T00:00:00.000Z' _updatedAt: type: string format: date-time nullable: true example: '2024-01-01T00:00:00.000Z' _reference: nullable: true type: string example: string required: - entryNodeId - nodes - name - _id - _createdAt securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: >- Use the format `X-API-KEY YOUR_API_KEY`. Each key is tied to a single broadcast. ```` ## Related topics - [Delete workflow resource](/api-reference/workflow-resource/delete-workflow-resource.md) - [List workflow resource](/api-reference/workflow-resource/list-workflow-resource.md) - [Create workflow resource](/api-reference/workflow-resource/create-workflow-resource.md) - [Get workflow resource](/api-reference/workflow-resource/get-workflow-resource.md) - [Update broadcast resource](/api-reference/broadcast-resource/update-broadcast-resource.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.