Home Integrations Setting Up Webhooks

Setting Up Webhooks

Last updated on Apr 01, 2026

Webhooks let GrowerIQ notify external systems when something happens, such as a lot being created, an order shipped, or a harvest recorded. Instead of polling the API on a schedule, GrowerIQ pushes event data to a URL you specify the moment an event occurs.

In this article

How Webhooks Work

When an event occurs in GrowerIQ, the system follows this sequence:

  1. An event occurs (for example, a lot is created or a shipment is marked as delivered).
  2. GrowerIQ checks for webhook subscriptions that match the event's activity type.
  3. For each matching subscription, GrowerIQ sends an HTTP POST request to the configured endpoint URL.
  4. The payload is signed with HMAC-SHA256 using the subscription's signing secret so your receiver can verify authenticity.
  5. The delivery attempt and response are recorded in the delivery log.

Organisation-wide subscriptions

Webhooks are configured at the organisation level, not per-integration. A single webhook subscription receives events from all integrations and internal operations that match the selected activity types.

Creating a Webhook Subscription

Follow these steps to create a new webhook subscription:

  1. Navigate to Administration > Webhooks.
  2. Click Create Webhook.
  3. Enter the Endpoint URL for the system that will receive events. The URL must use HTTPS.
  4. Select one or more Activity Types that should trigger a delivery to this endpoint.
  5. Click Create.

After creation, GrowerIQ displays the signing secret for this subscription.

Save your signing secret immediately

The signing secret is displayed only once at creation time. Copy it and store it in a secrets manager or password vault before closing the dialog. You cannot retrieve this secret later. If it is lost, you must regenerate it (which invalidates the previous secret).

Webhook subscriptions page showing active and paused webhook cards

Choosing Activity Types

Activity types determine which events trigger a webhook delivery. Select only the types your receiver needs.

Category Activity Types
Cultivation Batch created, harvest recorded, drying complete, curing complete
Inventory Lot created, lot transferred, weight adjusted, destruction queued, destruction completed
Orders & Shipments Order created, order status changed, shipment shipped, shipment delivered
Quality & Compliance Sample created, lab results received, CAPA opened, deviation recorded, recall initiated
Plant Care Pesticide applied, fertiliser applied, cuttings propagated, seeds germinated
Production Crude extraction recorded, distillation recorded, final product weights recorded

Start narrow, expand later

Subscribe to only the activity types your integration needs right now. You can add more types at any time by editing the subscription. Fewer subscriptions means less noise and easier debugging.

Testing Your Webhook

Before relying on a webhook in production, verify that your endpoint receives and processes payloads correctly.

  1. Open the webhook subscription detail page by clicking on the subscription in Administration > Webhooks.
  2. Click Test Webhook. GrowerIQ sends a sample payload to your endpoint.
  3. Check the Delivery Log on the subscription detail page. A successful delivery shows a 2xx status code. A failed delivery shows the HTTP status or error returned by your endpoint.

Use webhook.site for initial testing

If you do not have a receiver ready, create a temporary endpoint at webhook.site and use that URL when creating the subscription. This lets you inspect the exact payload structure and headers GrowerIQ sends before you write any receiver code.

Managing the Signing Secret

The signing secret is a shared key used to compute the HMAC-SHA256 signature included in every webhook delivery. Your receiver uses this secret to verify that payloads genuinely come from GrowerIQ and have not been tampered with.

Regenerating the secret

If the signing secret is lost or compromised:

  1. Update your receiver first. Prepare your receiver to accept a new secret so there is no gap in verification.
  2. Navigate to the webhook subscription detail page.
  3. Click Regenerate Secret.
  4. Copy and store the new secret immediately.
  5. Deploy the new secret to your receiver.

Regeneration invalidates the previous secret

As soon as you regenerate, the old secret stops working. Any deliveries signed with the old secret will fail verification on your receiver. Update your receiver before or immediately after regenerating to avoid missed events.

Editing and Deleting Webhooks

Editing a subscription

To change the endpoint URL or update the selected activity types:

  1. Navigate to Administration > Webhooks.
  2. Click on the subscription you want to modify.
  3. Update the Endpoint URL or toggle Activity Types as needed.
  4. Click Save.

Changes take effect immediately for all subsequent events.

Deleting a subscription

To remove a webhook subscription:

  1. Navigate to Administration > Webhooks.
  2. Click on the subscription you want to remove.
  3. Click Delete.
  4. Confirm the deletion.

Deleting a subscription cancels any pending deliveries and stops all future deliveries for that endpoint. This action cannot be undone.