If you want to automate your user management without writing custom code, you can integrate your Deal.ai API routes with Zapier using the "Webhooks by Zapier" action. This guide will walk you through setting up a Zap to automatically manage users on your white-labeled Deal.ai site.
1. Deal.ai API Prerequisites
Before you begin, ensure you have completed these two setup steps in your Deal.ai dashboard:
Enable the API: Navigate to your Deal.ai White Label Settings and toggle the API to enabled.
Get Your API Key: Retrieve your unique key from the bottom of your Account Settings page.
2. Setting Up a Zap to Add a Deal.ai User
Follow these steps to automatically create a new user in your Deal.ai system based on an external trigger.
Create a New Zap: Log in to Zapier and click "Create Zap." Choose the trigger app and event that will start the process (for example, a new row in a Google Sheet or a new sale in Stripe).
Set Up the Webhooks Action: For the action step, search for and select Webhooks by Zapier as the app. Choose POST as the action event.
Configure the Webhooks Action:
Payload Type: Select json.
Data: Map the following fields to the information from your trigger app to send it to Deal.ai:
firstName: Map to the user's first name.lastName(optional): Map to the user's last name.email: Map to the user's email address.password(optional): Map a specific password field, or leave blank to let Deal.ai generate a random one securely.sendInviteEmail: Type "yes" to send an automated invite, or "no" to skip it.role(optional): Type the exact name of the role as it appears in your White Label settings.
Headers: Add a header named
Deal-AI-API-Keyand paste your API key as the value.
Test and Activate: Follow the prompts to test the action. If the new user successfully appears in your Deal.ai White Label dashboard, turn on your Zap!
3. Setting Up a Zap to Remove a Deal.ai User
Follow these steps to automatically revoke access and delete a user from your Deal.ai platform.
Create a New Zap: Select your trigger app and event as usual.
Set Up the Webhooks Action: Select Webhooks by Zapier and choose DELETE as the action event.
Configure the Webhooks Action:
Payload Type: Select json.
Data: Map the
emailfield to the email address of the user you wish to remove from Deal.ai.Headers: Add the
Deal-AI-API-Keyheader with your API key.
Test and Activate: Run the test to confirm the user is removed from Deal.ai, then turn on your Zap.
4. Setting Up a Zap to Update a Deal.ai User's Role
Follow these steps to automatically upgrade or downgrade a user's permissions inside Deal.ai.
Create a New Zap: Select your trigger app and event.
Set Up the Webhooks Action: Select Webhooks by Zapier and choose PATCH as the action event.
Configure the Webhooks Action:
Payload Type: Select json.
Data:
email: Map to the Deal.ai user's email address.role: Map to the new role name. To remove a role and revert to the Default Role in Deal.ai, you can leave this field completely empty.
Headers: Add the
Deal-AI-API-Keyheader with your API key.
Test and Activate: Confirm the role update works as expected in your dashboard, then activate your Zap.
5. Important Notes for Deal.ai Automations
Keep these best practices in mind when connecting Deal.ai to external tools:
Security: Keep your Deal.ai API Key highly secure. Never share it in public forums or unprotected documents.
Accuracy: Double-check your data mapping to ensure you aren't accidentally removing or updating the wrong users in your system.
Automation: Using Zapier Webhooks allows you to connect your Deal.ai white-labeled site to over 5,000+ apps, drastically streamlining your workflow and saving you hours of manual data entry.