Introduction to Webhooks
InsCipher notifies your custom endpoint whenever a specific platform change occurs.
Webhooks are custom HTTP callbacks that activate upon specific events. For example - when a new status is applied, a payment is updated. When this event occurs, InsCipher will transmit data to a customer-specified URL, enabling smooth integration and automation between various web services. Webhooks can be configured to notify end users about important events within the InsCipher platform as they occur, ensuring instant updates and the ability to automate workflows without a need to worry about strenuous polling - optimizing efficiency and accuracy in surplus lines tax filing and compliance management.
This documentation gives an overview of the configuration, testing and maintenance of webhooks - including information regarding available system events, authentication, security and more.
Webhook Categories
Webhook Categories allow for greater compartmentalization of event types and are grouped by InsCipher entity type. The following categories contain events that are currently available to subscribe to.
- Transaction
- Batch
- Taxes and Fees
Available Event Types
The following event types are available within InsCipher per agency. You can subscribe to one or many, depending upon your workflow.
| Event Name | Event Description |
|---|---|
| Transaction Status Updated to 'Filed' | An individual transaction or multiple transactions within a state export have been successfully filed with the corresponding state. |
| Batch Status Updated to 'Processed' | A single batch of transactions have been successfully moved to the 'processed' state within the InsCipher platform. |
| Stamping Fee Paid Date Updated | The paid date of a single Stamping Fee has been updated. |
| SL Tax Paid date Updated | The paid date of a single Surplus Lines Tax has been updated. |
Responses
Successful responses are indicated by a 200 status code.
Retries
In the event of a failed delivery of a webhook request, InsCipher will attempt 3 times to deliver the data before reaching out via email to advise on next steps, which can involve a manual data import. The following is a breakdown of this retry cadence:
| After Failure # | Webhook / System Behavior |
|---|---|
| 1 | Immediate retry |
| 2 | Retry after 30 minutes from Failure #1 |
| 3 | Retry after 30 minutes from Failure #2 |
| 4 | Email notification with instructions on how to import missing data manually. |
Limitations
Though there are no rate limiters in place, all webhook requests are processed through a system queue before being sent to the endpoint(s) provided. Please submit a support ticket with as much detail as possible if you notice any delay in webhook responses.
Updated 5 days ago