Skip to main content

Webhooks Overview

Webhooks are a way for Govly to notify your applications of events that happen in your Govly account. The webhooks are sent as HTTP POST requests to a URL that you specify. You can configure webhooks from Govly’s API integration dashboard.

Payload Format

Webhooks from Govly will include a JSON payload that is dependent on the event type. However, all payloads will have the following shape by default:
{
  "event": "EVENT_TYPE.ACTION",
  "payload": {
    // Event-specific data
  }
}

Custom Payload Templates

You can create custom templates for your webhook payloads. This allows you to customize the data so that it better fits your destination. Here is an example of a custom template for a webhook based Slack integration:
{
  "event": "OPP_WORKSPACE.INTEND_TO_BID",
  "text": "[SEWP RFQ 123](https://govly.com/opportunities/123) has been marked as Intend to Bid."
}

Headers

By default, webhooks from Govly will be sent with the following headers:
HeaderDescription
Govly-Webhook-SignatureSHA2 hex digest of your Webhook Signature Key and the JSON payload
User-Agentgovly-webhooks/1.0
Content-Typeapplication/json

Retries and Stop Mechanisms

Each webhook event will be retried 10 times with an exponential backoff. After a given webhook has 100 failed consecutive deliveries, it will be automatically disabled to prevent your server from being overwhelmed. You can view the payload and response status for webhook events in the Govly UI. You can also resend a webhook event directly from the UI.