Web Hooks Configuration Documentation
Introduction
Web hooks in Clarico empower users to invoke external web applications based on specific events. This documentation guides users through the configuration of web hooks, detailing the necessary parameters and options.
Web Hook Configuration Parameters
Name:
- Definition: The name assigned to the web hook.
- Example: Quote
WebHook
Authorization Name:
- Definition: The connection name responsible for authenticating the external web application.
- Example:
APIKeyConnection
End Point URL:
Method:
- Definition: The required HTTP method for communication with the external web application (GET or POST).
- Example:
POST
App Name:
- Definition: The name of the external web application.
- Example:
InvoiceApp
Parameter:
- Definition: Additional parameters required for the web hook (if any).
Enabled:
- Definition: Toggle to enable or disable the web hook.
- Example: Enabled
Web Hook Triggers
Triggers determine when the web hook should be fired. Choose from the following options:
Submit:
- Definition: Triggered when the item is won.
Create:
- Definition: Triggered when the item is created.
Update:
- Definition: Triggered when the item is updated.
Delete:
- Definition: Triggered when the item is deleted.
Example Configuration
Name: InvoiceWebHook
Authorization Name: APIKeyConnection
Method: POST
App Name: InvoiceApp
Parameter: [additional parameters]
Enabled: Enabled
Triggers:
- Submit
- Create
- Update
- Delete
Conclusion
Configuring web hooks in Clarico provides a powerful way to integrate external web applications seamlessly. Ensure that the parameters are accurately set based on the requirements of your external application. If you have any questions or face issues, don't hesitate to reach out to our support team.