Webhook - Setting up your Webhook Integration

This guide will walk you through the steps to set up your webhook integration

Integration Steps

1. Login to the Firstbase App and visit the "Integrations" Page

2. Find the "Webhook" option in the list of "Available Integrations" and click on it

3. Visit the "Webhook" setup screen inside the integrations page

Once you've clicked on the webhook option, you'll be redirected to configure your webhook integration.

4. Generate your "Secure Key"

Click on generate secure key and store your key. You'll need when you set up your onboarding, updating and offboarding flows. 

5. Get the callback URL for each of your flows

Within each flow, you'll see a different Firstbase callback URL of the form: 

https://api.firstbasehq.com/webhook/integration/onboard_user

Copy this value for each of the flows. You'll need them to continue configuring your webhook.

6. Configure your Onboarding, Updating or Offboarding Webhook

Onboarding

• Configure your webhook:
  • The callback URL should be added as part of the configuration based on the system you are using to do the webhook request. 
  • In the JSON payload for the webhook, add the secure key from previous steps as the first part of the request.
  • Add the rest of the JSON payload. An example payload is shown below. You can copy paste the below payload and replace each field in bold with your variables. 

{"secureKey": "abc123",

"firstName": "John",

"lastName": "Smith",

"personalEmail": "john.smith@google.com",

"workEmail": "john.smith@firstbase.com",

"startDate": "2024-01-15",

"countryCode": "US",

"region": "CA",

"postalCode": "90022",

"city": "Los Angeles",

"streetAddress": "86 East Edgefield Dr.",

"department": "Engineering",

"phoneNumber": "0600000000" }

Updating

• Configure your webhook:
  • The callback URL should be added as part of the configuration based on the system you are using to do the webhook request. 
  • In the JSON payload for the webhook, add the secure key from previous steps as the first part of the request.
  • Add the rest of the JSON payload. An example payload is shown below. You can copy paste the below payload and replace each field in bold with your variables. 

{"secureKey": "abc123",

"firstName": "John",

"lastName": "Smith",

"personalEmail": "john.smith@google.com",

"workEmail": "john.smith@firstbase.com",

"countryCode": "US",

"region": "CA",

"postalCode": "90022",

"city": "Los Angeles",

"streetAddress": "86 East Edgefield Dr.",

"department": "Engineering",

"phoneNumber": "0600000000" }

Offboarding

• Configure your webhook:
  • The callback URL should be added as part of the configuration based on the system you are using to do the webhook request. 
  • In the JSON payload for the webhook, add the secure key from previous steps as the first part of the request.
  • Add the rest of the JSON payload. An example payload is shown below. You can copy paste the below payload and replace each field in bold with your variables. 

{"secureKey": "abc123",

"email": "john.smith@google.com",