Setup

Prerequisites

• Partner Integration: You must have an active BudSense Partner Integration with assigned companies.
• Endpoint Requirements: Your listener URL must be publicly accessible and use HTTPS for transport security. Invalid URLs will be rejected.

Registration

To enable webhooks, you must register your listener URL programmatically via the Update Partner Config endpoint.

Updating Webhook URL

To update your webhook URL, you must call the Update Partner Config endpoint with the new URL, and set enabled to true. This will activate webhook delivery to the specified URL.

The URL you specify must be publicly accessible, use HTTPS for transport security, and accept POST requests. See the Delivery & Reliability page for more details.

Example request body:

{
  "partnerId": "PARTNER_ID",
  "partnerName": "BudSense Sandbox Integration",
  "enabled": true,
  "webhook": {
    "enabled": true,
    "url": "https://yourdomain.com/webhooks/budsense-updates"
  }
}

Data Authorization & Scope

Webhooks are strictly scoped to your permissions:

• Company Scope: You will only receive webhooks for companies explicitly assigned to your partner account. You can verify your list of authorized companies via the allowedCompanies array in the Get Partner Config endpoint.
• Product Scope: A notification is only triggered if the updated product exists in at least one company enabled for your account.