Configuration
Setup within Connect
To set up Webhooks within Connect, you will need to review the following fields that are required for the initial configuration, and set up a call with InsCipher Sales if you are a new client, or InsCipher Implementation if you are an existing client.
Important fields within the Configuration
Some of the following fields are necessary to be provided to InsCipher in the setup of Webhooks. Though a field may not be required, we encourage adding additional context where needed. You can always update information at any time if your configuration changes or if you wish to remove the Configuration.
Field | Description | Required |
---|---|---|
Webhook Title | Name of the webhook | Yes |
Webhook Description | Important notes to store about the webhook | No |
Webhook Event | The InsCipher Webhook event being subscribed to. For more information on available events, click here | Yes |
Webhook URL | Full endpoint of the URL to receive request data to | Yes |
Header Key | Unique key to be stored into the webhook configuration for message validation and security. At this time, no special characters are allowed. | No |
Header Value | Corresponding unique value to the Header Key | No |
States to apply configuration | All US states to apply the current webhook configuration to. | Yes |
State specific configuration
Webhook events in InsCipher can be applied on a per state basis within your agency. This means that you can apply one event to, for example, 1 or 2 states and another event to all states within your agency, and so on.
Utilizing Headers
Headers are custom input data that can be set up during the webhook configuration process and allow you to further secure incoming requests - such as including signatures to verify the payload or to authenticate secret keys. At this time, only one set of key/value pair can be applied per webhook configuration. When setting up a header, please keep the format to single word text format and keep special characters limited. We're working on expanding functionality in this area.
Updated about 1 month ago