Setting Up Webhook Integrations in Drimify
Setting Up Webhook Integrations in Drimify
Drimify's webhook integrations allow you to automatically send participant data to external services whenever a user completes or interacts with your app. You can connect to a Custom API, HubSpot, or Salesforce — and for each, you can define exactly which data fields get transmitted.
Getting Started
Navigate to Settings → Integrations. If no integrations have been configured yet, you will see the "No webhook integrations yet" placeholder screen.
Click + Add New Integration (available both in the top-right corner and in the center of the page) to open the integration selector.
Selecting an Integration Type
A modal will appear titled "Select Webhook Integration". You can filter by category using the dropdown (defaulting to All). The three available integrations are:
- Custom API — for any REST API endpoint you control
- HubSpot — for CRM & Marketing automation via HubSpot
- Salesforce — for Salesforce CRM
Click the tile for the integration type you want to configure.
Custom API Integration
Authentication
After selecting Custom API, the Add Integration panel opens with the following fields:
Integration Name A label for your own reference (defaults to "Custom API Integration"). You can rename it to something descriptive.
API Endpoint The full URL of your webhook receiver (e.g. https://api.example.com/webhook). This must be an HTTPS endpoint.
API Key Type Choose the authentication method your endpoint uses. Options are:
Option | Description |
|---|---|
None | No authentication header is sent |
API Key (X-API-KEY) | Sends the key in an |
Bearer Token | Sends the key as |
Basic Auth | Sends Base64-encoded |
Custom Header | Lets you define your own header name (e.g. |
When Custom Header is selected, an additional Custom Header Name field appears where you enter the header key name.
API Key The secret value sent with the chosen authentication method.
Verify Connection Click this button to test whether Drimify can successfully reach your endpoint with the provided credentials before saving.
HubSpot Integration
After selecting HubSpot, the panel shows:
Integration Name Defaults to "HubSpot Integration".
API Key / Access Token Paste your HubSpot Private App Access Token here. HubSpot deprecated legacy API keys in 2022, so you should use a Private App token generated from your HubSpot account under Settings → Integrations → Private Apps.
Verify Connection Tests the token against the HubSpot API before saving.
Salesforce Integration
After selecting Salesforce, the panel shows:
Integration Name Defaults to "Salesforce Integration".
Salesforce Domain Your Salesforce instance URL (e.g. yourcompany.my.salesforce.com).
Consumer Key and Consumer Secret These are obtained from a Connected App configured in Salesforce under Setup → App Manager → New Connected App. Drimify uses the OAuth 2.0 client credentials flow.
External ID Field Name The API name of the field used to match (upsert) records — typically Email_External_Id__c or a custom external ID field on the Contact or Lead object. This field must be marked as External ID in Salesforce.
External ID Source A dropdown to select which Drimify data field to use as the matching key (e.g. Email).
Verify Connection Tests the Salesforce OAuth connection before saving.
⚠️ Required Fields for Salesforce
Salesforce enforces required fields at the object level. If you are upserting Leads, Salesforce requires at minimum:
- Last Name (
lastName) — mandatory for Lead creation
If you are upserting Contacts, Salesforce requires:
- Last Name (
lastName) — mandatory for Contact creation
Email is not required by Salesforce's schema by default, but it is almost always needed as the External ID to correctly match and deduplicate records on upsert. Without a reliable external ID match, Salesforce will create duplicate records or return an error.
Best practice: Always map at minimum Last Name and Email when connecting to Salesforce. Omitting Last Name will cause the webhook to return an error and the record will not be created or updated.
Field Mapping
Available on all three integration types, Field Mapping lets you specify exactly which Drimify data fields are sent to your integration, and under what key names.
Click + Add Field to add a mapping row. Each row consists of:
- Webhook field (left) — the key name that will appear in the outgoing payload (you define this, matching your integration's expected field names)
- → Source field (right dropdown) — the Drimify data field to map to it
Available Drimify Source Fields
Display Name | Field Key |
|---|---|
Address | |
App ID | |
App Reference | |
Code | |
Company Name | |
Connection Country | |
Country | |
Country Code | |
Custom Checkbox | |
Custom Format | |
Custom Text | |
Date | |
Date of Birth | |
Date With Timezone | |
| |
First Name | |
Gender | |
ID | |
Idunic | |
IP Address | |
Last Name | |
Levels Played | |
Locale | |
Optin Newsletter | |
Phone Number | |
Played | |
Postal Code | |
Profil | |
Profil UID | |
Prize Ref | |
Prize Title | |
Prize UID | |
Referral | |
Score | |
Select Value | |
Select Value 2 | |
Session ID | |
Time Taken | |
Town | |
Updated At | |
Updated At Timestamp | |
Username | |
Website | |
You can add as many rows as needed. To remove a mapping, click the trash icon on the right side of the row.
Available in Workspaces
At the bottom of every integration form is an Available in Workspaces section. Use the toggle next to each workspace to control which workspaces can use this integration. Click Select All to enable it for all workspaces at once.
Saving and Managing Integrations
Once all fields are filled in, click Save Changes to create the integration. It will then appear in the main Integrations list. You can edit or delete existing integrations from that list at any time.
Click Cancel to discard any unsaved changes.
Updated on: 05/03/2026
Thank you!