Overview

Brij’s Webhook integration enables seamless data transmission by automatically sending event-triggered payloads to a designated webhook URL. Events such as Registration Initiation, Submission, Approval, Denial, Form Submission, and Review Submission act as triggers, generating a configurable data payload that is delivered to external systems in real-time.

All event triggers and their associated properties can be customized within Brij’s no-code Automations setup wizard, allowing for flexibility in how and when data is sent. If the receiving application requires the payload data to be reformatted for proper ingestion, middleware may be necessary to transform the data before it reaches its destination.

💡 For assistance with custom middleware integrations, you can contact Brij Support to explore tailored solutions that ensure compatibility with your specific tech stack.

How to Configure a Webhook in Brij Automations

1. In the Integration tab, select Webhook from the available options.

   

2. In the Authentication tab:

   • Give your webhook a name.

   • Select the webhook type (Internal or External).

   • Enter the Webhook URL.

     

3. In the Filters tab:

   • Choose the Brij experiences for which you want this webhook to run.

   • To apply the webhook to all experiences, select All Experiences from the dropdown.

     

4. In the Action tab, select the latest version of the webhook integration.

   

5. In the Triggers & Properties tab:

   • Choose the specific Brij events that should trigger the webhook (see “Triggers & Properties”) section below for a complete list of triggers and properties.

   Note: Not all properties will be available for every trigger. Only the properties captured at the time of the trigger event will be sent.

   For example, if a customer enters their purchase channel during the registration process, this property will be included in the Registration Submission event but not in the Registration Initiation event, as it was entered after the initiation event occurred.

   

   Note: To optimize performance, only include events relevant to your use case.

   

6. In the Configuration tab:

   • Optionally, add an HMAC signing key, or leave it blank to generate one automatically.
   • Configure automation settings, such as:

     • Pausing the automation after a set number of failures.

     • Enabling email notifications when the automation is paused or for every error.

       

Available Webhook Triggers & Properties:

Trigger Events:

Registration Initiation

• This event is triggered when a user begins the registration process but has not yet completed it. It captures basic details such as device, location, and experience data, but may not include all customer-provided information.

Registration Submission

• This event occurs when a user successfully submits their registration. It includes all data captured up to that point, including customer details, registration information, and any additional inputs provided during the process.

Registration Approval

• Triggered when a registration request is approved, either manually or automatically. It includes all relevant registration data along with admin approval details.

Registration Denial

• Occurs when a registration request is denied. Similar to the approval event, it contains all relevant data along with the reason for denial and admin details.

Form Submission

• This event is triggered when a user submits a form, such as a survey or product feedback form. It includes standard device, location, and experience data, along with form-specific fields such as form module name and submitted responses.

Review Submission

• This event captures when a user submits a product or experience review. It includes relevant metadata, such as the product reviewed, the rating given, and any written feedback.

Properties:

General Event Data

• Event Timestamp: 2021-07-01T00:00:00Z (date)

Device Data

• Device Name: Apple iPhone (string)
• Device Type: Mobile (string)
• Device Browser: Mobile Safari 17.4.1 (string)
• Device Language: en-US (string)
• Device OS: iOS 17.4.1 (string)
• Device Screen Resolution: 1920x1080 (string)

Location Data

• City: Jersey City (string)
• Country: US (string)
• State: New Jersey (string)
• Zip Code: 07310 (string)
• Latitude: 34.0522 (number)
• Longitude: 118.2437 (number)
• Location Type: IP | GPS | Unknown (enum)

Experience Data

• Experience Type: WebApp Product | WebApp Variant | Rebate | Digital Hub | Dynamic Link (enum)
• Experience Name: Outer edge Hoodie experience (string)
• Experience Title: Outer edge Hoodie (string)
• Experience Subtitle: The best hoodie you'll ever own (string)
• Experience URL: https://brij.it/c/RUTY (string)
• Experience Product/SKU Number: 123456 (string)
• Experience Description: The outer edge hoodie is the perfect blend of style and comfort (string)
• Experience Image: https://brij.it/c/RUTY/image.jpg (string)
• Experience Brij ID: RUTY (string)
• Experience Serial Number: ABCDEF1234567890 (string)
• Experience Lot Number: ABC123-1 (string)

Customer Data

• Customer IP: 192.168.1.1 (string)
• Email: test@brij.it (string)
• Phone Number: 123-456-7890 (string)
• First Name: John (string)
• Last Name: Appleseed (string)
• Email Consent: true (boolean)
• SMS Single Consent: true (boolean)
• SMS Double Consent: true (boolean)
• Address: 123 Main St, Apt 1, New York, NY 10001, US (string)
  • Line 1: 123 Main St (string)
  • Line 2: Apt 1 (string)
  • City: New York (string)
  • State: NY (string)
  • Zip Code: 10001 (string)
  • Country: US (string)

Registration Data

• Registration ID: 123456 (string)
• Date: 2021-07-01T00:00:00Z (date)
• Method: email | phone (enum)
• Warranty Duration: 1 year (string)
• Expiry Date: 2025-07-01T00:00:00Z (date)
• Status: pending | active (enum)
• Module Name: Sweepstakes Signup (string)
• Discount Code: BRIJ-123ABC (string)
• Discount URL: https://www.store.myshopify.com/discount/BRIJ-123ABC (string)
• Purchase Date: 2024-06-05T00:00:00Z (date)
• Purchase Quantity: 1 (number)
• Purchase Channel: website (string)
• Purchase Receipt:
  • https://www.example.com/receipt1.jpg
  • https://www.example.com/receipt2.jpg (array of strings)
• Serial Number: ABCD1234 (string)
• Note: Note text (string)

Admin Data

• Approval Type: Manual | Automatic (enum)
• Approver: support@brij.it (string)

Form Data

• Form Module Name: Survey (string)
• Form Responses: { key1: "value1", key2: "value2" } (object)

Review Data

• Review Module Name: Survey (string)
• Review Title: Amazing Product (string)
• Review Text: This product worked great... (string)
• Review Rating: 5 (number)
• Review Display Name: John S (string)
• Review Upload: https://v2.brij.it/optimized-images/PYqyGngXcy2SjQ7qc.webp (string)
• Review Form Data: { key1: "value1", key2: "value2" } (object)