Webhook Sample Payloads

Events Covered

The following events can be covered by webhooks:

Event TypeDescription
quote.statusThis event is triggered whenever status of a quote changes (e.g., a quote goes from a referral to a READY status).
policy.statusThis event is triggered whenever status of a policy changes (e.g., a policy is issued or is cancelled.
policy.documentThe event notifies a partner when a policy document is ready to be downloaded.
policy.certificateThe event notifies a partner when a certificate document is ready to be downloaded.
account.statusThis event notifies a partner when status of an account changes (e.g., QUOTED, ACTIVE POLICY, etc.).
policy.endorsement.documentThe event is triggered when an endorsement is prepared.
policy.non-renewal.documentThe event is triggered when policy non-renewal document is generated.

Quote Notice

Below is a sample of the webhook request that will be sent out if status of a quote changes (for example, after a quote has been reviewed and released by an underwriter):

{
"meta": {
       "event": "quote.status"
},
"data": {
        "quoteId": "16e420fa-7e73-4cd0-9bb5-a027860164f2",
        "quoteNumber": "QCB-250-QQONJSXI",
        "quoteStatus": "READY",
        "modified": "2021-05-13T06:07:54.407+0000",
        "effectiveDate": "2021-05-26T00:00:00.000+0000",
        "endDate": "2022-05-26T00:00:00.000+0000", 

       "accountId": "877e9ee2-8ee0-4fe3-9658-b9cae24303f7",
       "accountName": "Red Rock Test Company",
       "customerFirstName":"Customer",
       "customerLastName":"Customerlast",
       "customerEmail":"[email protected]",
       "customerPhone":"1234121321",			
       "agencyId": "2e054852-b63a-43da-bb78-28205748b658",
       "agencyName": "Quote First",
       "agentEmail":"[email protected]",
       "agentFirstName": "Firstname",
       "agentLastName": "Lastname"
   }
}

Policy Notice

The following payload will be sent out after a policy has been issued:

{
"meta": {
       "event": "policy.status"
},
"data": {
        "quoteId": "16e420fa-7e73-4cd0-9bb5-a027860164f2",
        "policyId": "16e420fa-7e73-4cd0-9bb5-a027860164f2",
        "policyNumber": "PLM-QGTGSXI",
        "policyStatus": "ISSUED",
        "modified": "2021-05-13T06:07:54.407+0000",
        "effectiveDate": "2021-05-26T00:00:00.000+0000", 
        "endDate": "2022-05-26T00:00:00.000+0000", 

       "accountId": "877e9ee2-8ee0-4fe3-9658-b9cae24303f7",
       "accountName": "Red Rock Test Company",
       "customerFirstName":"Customer",
       "customerLastName":"Customerlast",
       "customerEmail":"[email protected]",
       "customerPhone":"1234121321",			
       "agencyId": "2e054852-b63a-43da-bb78-28205748b658",
       "agencyName": "Quote First",
       "agentEmail":"[email protected]",
       "agentFirstName": "Firstname",
       "agentLastName": "Lastname"
   }
}

Non-Renewal Notice

This webhook notice will be sent out in case of a non-renewal due to a carrier change:

"meta": {
       "event": "policy.non-renewal.document"
},
"data": {
        "policyId": "<string>",
        "policyNumber": "<string>",
        "modified": "2021-05-13T06:07:54.407+0000",
        "expiresOn": "2021-05-26T00:00:00.000+0000", 
       "accountId": "877e9ee2-8ee0-4fe3-9658-b9cae24303f7",
       "accountName": "Red Rock Test Company",
       "customerFirstName":"Customer",
       "customerLastName":"Customerlast",
       "customerEmail":"[email protected]",		
       "agencyId": "2e054852-b63a-43da-bb78-28205748b658",
       "agencyName": "Agency Name",
       "agentEmail":"[email protected]",
       "agentFirstName": "Firstname",
       "agentLastName": "Lastname",
       “productType”: “P100”,
       “documentUrl”: “<string>”,
       “docType”: “Non_Renewal”,
       “nonRenewalReason”: “Policy is nonrenewed due to a carrier change. A quote will be offered on new paper.“
   }
}

This webhook notice will be sent out in case of a non-renewal due to the underwriting reasons:

"meta": {
       "event": "policy.non-renewal.document"
},
"data": {
        "policyId": "<string>",
        "policyNumber": "<string>",
        "modified": "2021-05-13T06:07:54.407+0000",
        "expiresOn": "2021-05-26T00:00:00.000+0000", 
       "accountId": "877e9ee2-8ee0-4fe3-9658-b9cae24303f7",
       "accountName": "Red Rock Test Company",
       "customerFirstName":"Customer",
       "customerLastName":"Customerlast",
       "customerEmail":"[email protected]",		
       "agencyId": "2e054852-b63a-43da-bb78-28205748b658",
       "agencyName": "Agency Name",
       "agentEmail":"[email protected]",
       "agentFirstName": "Firstname",
       "agentLastName": "Lastname",
       “productType”: “P100”,
       “documentUrl”: “<string>”,
       “docType”: “Non_Renewal”,
       “nonRenewalReason”: “Policy is nonrenewed due to underwriting guidelines. Please contact your Cowbell representative to determine if another Cowbell product can be quoted.
“
   }
}