This article will show you how to implement webhooks in your organisation in Capptions Direct.
Before we get started
Take note
- You can only implement a webhook in a workflow if you are an "owner" or "admin" of the organization.
- You can only implement a webhook in a workflow via the web portal.
- A Form and Workflow are needed to implement a webhook in your workflow.
- To be able to choose an data source for your webhook, a Fill a Form node is needed with a form containing a field.
Building a formula in a workflow
Step 1: Sign in to the Capptions Direct web portal
Sign in to your Capptions Direct account using the linkStep 2: Select an organization
Click on the drop-down arrow in the top left-hand corner and select the organization you would like to add a Target Line to your graph to.
Step 3: Click on settings
Click on the settings tab in the bar at the top of the screen
Step 4: Click on webhooks
Click on the webhooks tab in the second bar at the top of the screen
Step 5: Click on create Webhook
Click on create webhook in the top right of the Manage Webhooks tab
Step 6: Fill in the webhook information
6.1 Fill in the name of your webhook
6.2 Fill in the URL of your webhook
6.3 Fill in the Scope of your webhook
Step 7: Click create
Click create to finish creating your webhook
Step 8: Click on Templates
You will immediately land on the form template listing page.
Step 9: Click on the Workflow tab
Click on the Workflow tab to create and edit Workflows in your organization.
Step 10: Click on the Edit menu (3 Dots) on the right side of the workflow
If you do not have a workflow yet, see our article on making your first workflow.
If you already have a workflow:
10.1 Navigate to your workflow.
10.2 Click on the edit menu (3 Dots) on the right side of the workflow to edit your workflow.
Step 11: Add a Send API webhook node
If your workflow is empty or does not contain the preferred nodes. Please follow our Article on how to build a workflow.
If your workflow already contains preferred nodes, like fill a form or generate a report, you can add a Send API webhook node by:
11.1 Right-clicking somewhere on the grey work space
11.2 Then scrolling down to Integration triggers and choosing Send API webhook.
Step 12: Connect the Send API webhook node to the correct nodes
Now connect the Formulas & KPI's node to the correct form(s) for input variables by:
12.1 Clicking on the colored circles.
12.2 And dragging them to the corresponding colour on the fill a form node.
Step 13: Set webhook data
Click on Set webhook data to fill in the data source of your webhook integration
Now give your data item a name.
You can add an more items by:
13.1 Clicking on the add item button.
13.2 Filling in a name.
Step 14: Fill in your form
14.1 Now Fill in the designated form to add data to the process. Be aware that this will be the data that the webhook sends and recieves.
14.2 Click submit on your form to save all your answers.
Step 14: Choose the webhook
Choose a webhook you created to send data with by clicking on that webhook option.
And that's how easy it is!
We hope this article is helpful in implementing a webhook. if you have any questions or concerns, please do not hesitate to contact our customers support team at support@capptions.direct
Thank you for choosing Capptions Direct as your EHS Management Software, We look forward to helping you make your workplace safer and more efficient!