Creating a webhook configuration in Lucidum is the first step toward sending data from Lucidum to another application or solution.
Prerequisites #
Before defining the webhook configuration in Lucidum, you must first determine the URL that will listen for incoming webhooks on the application or solution.
Usually you can find this information in the API documentation for the solution or application.
If you need assistance, consult your Lucidum Account Executive.
Defining the Webhook Configuration #
To define the Webhook Configuration:
-
Choose Action Center from the left pane.
-
In the Action Center, choose the Webhook icon in the right pane.
-
To create a configuration for the action, click the Configuration (gear) icon. A configuration provides the connection and authorization information to communicate with the external solution.
-
In the Manage Action Configurations page, you can either click the Add Configuration icon (plus sign) or edit the Default configuration by clicking the Edit icon (pencil).
-
In the Manage Action Configurations page, enter the following:
-
Configuration Name. A name that describes the new Webhook configuration.
-
Webhook URL. The URL on the solution or application that listens for webhooks from Lucidum.
-
Header Key. You can accept the default value “Content-Type”.
-
Header Key Value. You can accept the default value “application/json”.
-
Max # of Records/Payload. You can specify a maximum size for the payload. The default value is 100 records. The maximum value is 5000.
-
-
In the Action Center, choose the Webhook icon in the right pane.
-
Click the Configuration (gear) icon.
-
In the Manage Action Configurations page, find your new configuration. Click its Test icon (page with checkmark) to test authentication and the connection.