Edit on Github

Webhook Actions

A schema that is used to validate a part of Laboperator workflow templates.

Schema

Options to set a webhook action

Webhook Actions
property name*
object
urlrequired
string

The URL that should be used in the webhook.

headers
object

The HTTP request headers

property name*
string
method
string
One of: get put patch delete post head
Default: post

The HTTP verb that will be used in the request

blocking
boolean

Defines if the webhook action will block the subsequent steps

body
string

The HTTP request body. You can add information about fields present in the workflow, and non-field information as well, using {{myInformation}}. Besides field identifiers, the following references are supported: - workflow_step: The current step of the workflow. Please refer to the API documentation for the keys available to use. - workflow_run: The current workflow run. Please refer to the API documentation for the keys available to use. - signal: details of what triggered the action. includes but not limited to:

  - type: What triggered the action, e.g. StepStart, Manual, etc
  - auth_token: Encoded reference to the active user access_tokens (applicable only in a SSO environment),
    may be blank if the active user can not be determined
  - pointer: Returns the pointer to the behavior that called the webhook
    (reference to the path inside the workflow template being used).

  
  • options: The options being used for the webhook action, i.e. URL, headers, handlers.
Example 1:
|
reference to a workflow field named 'volumeField' with a value of '10ml':
{
  "registered_value": {{volumeField}}
}
The example above will generate a request with the following body:
{
  "registered_value": "10ml"
}
Example 2:
|
reference to non-field information:
{
  "stepPointer": {{workflow_step.pointer}}
}
The example above will generate a request with the following body:
{
  "stepPointer": "/steps/externalStep"
}
onSuccess
reference
Webhook handler Schema
The handler for response status codes 2xx
onError
reference
Webhook handler Schema
The handler for response status codes 5xx
onCode
object

Define a different handler for specific codes.

property name*

Where is this used?

Other schemas that have a reference ($ref) to this schema.