Skyone
Skyone
English
English
  • Home
  • Data
    • Getting Started
      • Create an account
      • Recover Password
      • Quick Platform Guide
      • How to test the platform for free
      • Workspace
        • Creating a new Workspace
        • Find a Workspace
        • Sending an invitation to a Workspace
        • Editing a Workspace
      • Organizations
        • Creating an Organization
        • Organization Overview
        • Organization Management
        • Organization Monitoring
      • Settings and Preferences
        • Profile
        • Notifications
        • Usage and Billing
        • Users and Permissions
    • Modules
      • Module management
        • Creating a Module
        • Importing a Module
          • IAC Files - Integration as Code
        • Editing a module
        • Module Options
      • Settings and Operations
        • Module settings
          • Connectivity: Database
          • Connectivity: Email
          • Connectivity: REST
          • Connectivity: SOAP
          • Connectivity: File
          • Connectivity: RFC
          • Connected Account Management
        • Operations
          • Importing operations into REST Modules
          • Operation Management
        • Flows Using This Module
    • Monitoring
    • API Gateway
    • Terminals & Agent
      • Agent
        • Versions supported by Agent
        • How to Update the Agent Version
        • How to back up Agent files
      • Terminals
    • Data
      • Data Stack
        • Process Control
        • Data Stack Upload
        • File Actions
        • File Jobs
        • Data Job Parameters
        • Data Store
        • Data Share Features
        • ODBC
        • How to use the Data Engine Proxy
    • Integrations
      • Integration Management
        • Create integration
        • Import Integration
        • Edit Integration
        • Integration Options
        • Flows of this integration
      • Flows
        • Flow management
          • Creating a flow
          • Flow options
          • Flow Canva: configuring and editing the flow
            • Flow Canva: overview
            • Exception Handler
              • Exception Handler - Configuration
              • Exception Handler - Cases
            • Multicontext Flows
              • Example: Multicontext with an API Gateway
              • Example: Multicontext with a Time Trigger
            • Flow Settings
        • Triggers of a flow
          • API Gateway Triggers: Adding and Setting
          • AS2 Triggers: Adding and Setting
          • Queue Triggers: Adding and Setting
          • Flow Triggers: Adding and Setting
          • Time Triggers: Adding and Setting
          • Webhook Triggers: Adding and Setting
        • Tool Modules
          • AS2 Module
          • CSV Module
          • Data Transform Module
          • Data Balancer Module
          • EDI Module
          • Flow Call Module
          • IF Module
          • JavaScript Module
          • Log Module
          • Loop Do While Module
          • Loop For Module
          • Return Module
          • XML Module
          • Other Tool Modules
        • Module Header
        • Connecting components of a flow
        • Editing triggers and modules
        • Data Operations
          • Object Handling
            • Practical example: Handling variables
          • SMOP (Small Operations)
          • Parameterization rules
    • How to
      • Insert JSON into databases
      • Flattening: Data transformation using JSONata
      • How to use Form Data
      • Understanding recursion in JSONata
      • REST Module Output Consolidation
      • Isolated in execution: concept and application in variables
      • URL Parameters in API Gateway
      • Use case: API Gateway trigger parameters
      • Use case: Exception Handler in financial transactions
      • Use case: using Groups to manage access to flows
      • How to create a download endpoint and integrate with Power BI
      • Is it possible to use two triggers in a single flow?
      • How to set up WhatsApp in Skyone Studio
    • FAQ
    • GIGS: The complete guide
    • Glossary
  • Support
    • How do I request support?
    • Case Severity Levels
    • SLAs
    • Help & Resources
Powered by GitBook
On this page
  • Adding a Simple Webhook Trigger (HTTP)
  • Adding a Webhook Trigger with OpenAPI Schemas (HTTP)
  1. Data
  2. Integrations
  3. Flows
  4. Triggers of a flow

Webhook Triggers: Adding and Setting

PreviousTime Triggers: Adding and SettingNextTool Modules

Last updated 6 months ago

Here's how to add and configure a Webhook Trigger:

Adding a Simple Webhook Trigger (HTTP)

To add a Webhook trigger, follow these steps:

  1. Click on "Start with a trigger".

  2. Click on the plus sign of the "Webhook" option. You will then open the modal to configure it and view more information.

  3. This modal is divided into two areas: Info banner, Settings and Request specifications.

Settings

By default, the Webhook address is predefined on the platform, and you can copy it from the specific icon - located on the right-hand side of the screen.

In addition, there is the option to "Request authentication". Without using OpenAPI, you'll only have the option to enable request authentication with User (default) and Password (mandatory), which won't be required when running the flow within the platform:

Request specifications

Flows can be triggered using the following MEDIA TYPE formats:

  1. application/json

  2. application/x-www-form-urlencoded)

Select one of the two, according to your needs, using the arrow in the right-hand corner.

Execution limit

You can manage the number of executions of your Webhook Trigger through the "Execution Limit", i.e. determining the maximum number of times the WebHook will be requested over a period of time.

To do this, choose the number and time measure (second, minute or hour) you want.

BODY

Under "Use Body in request", use the enable button to show the feature. By default, the Body tab is displayed:

If you want to use the JSON format for platform to convert the code into YAML, use this tab of the Webhook trigger configuration and click "Generate Schema".

The platform will check that your JSON is valid and, if everything is OK, it will generate your YAML schema automatically.

Optionally, you can just use the BODY, without generating a YAML schema, by clicking "Save" to save your changes. This will prevent the platform from validating the type of parameter used.

If there is an error, check the error message, make the necessary corrections and try again.

Adding a Webhook Trigger with OpenAPI Schemas (HTTP)

As well as adding a simple Webhook trigger, we can add an OpenAPI - optional settings, but which allow us to pass parameters directly to the trigger, right at the start of the POST request.

To get started, under "Use Body in request", use the enable button to activate the feature. Next, choose the "Open API Schemas" tab.

Here, you will have the option of specifying your schema by adding parameters if you want to write your schema directly in YAML. Any parameters you add must be contained in the webhook_requestvariable. In the example above, we have a simple schema, with the csv parameter, which must be of string type. This parameter must be entered at the time of the POSTMAN (or similar) request. For better visualization, here is the same code in text:

components:
  schemas:
    webhook_request:
      type: object
      properties:
        csv:
          type: string

To finalize the trigger settings, click on "Save".

Read also:


.

This field allows you to use a body in JSON format, which you may or may not want to convert to YAML. When used, it appears as a parameter with the same name (body) in the other components of the flow, and you can filter your data using a SMOP or the tool module.

Find out about the Module Header here
Data Transformation
Edit trigger
Adding a Simple Webhook Trigger (HTTP)
Settings
Request specifications
Execution limit
BODY
Adding a Webhook Trigger with OpenAPI Schemas (HTTP)