In some cases, you can integrate with Firstbase directly by using a webhook. 

Apps supported via webhook include Enboarder and Rippling (Beta Testing). 

Use Cases Supported

1. Offboarding 

• Create an API key in your Firstbase app

Login to Firstbase then go to Settings > Firstbase API (https://app.firstbasehq.com/developer)

There, create a new api key called integrations-webhooks-offboarding and copy/paste it somewhere safe temporarily.

• Work with your CSM to get a webhook URL configured for you.
• You should use the webhook URL communicated by your Firstbase contact
• Configure your webhook:
  • Your webhook’s HTTP method should be POST
  • You should include a Authorization header with a value of ApiKey YOUR_API_KEY with YOUR_API_KEY being the key you generated in step 1
  • You should include a payload in json containing the email of the employee to offboard. 
  • Data passed should include:
    • Primary Email Address
• Here's an example of how the webhook configuration looks using Enboarder and Rippling:
  • Enboarder:
  • Rippling:

2. Onboarding without automatic package assignment

• Create an API key in your Firstbase app (you can use the same API key as for offboarding)

Login to Firstbase then go to Settings > Firstbase API (https://app.firstbasehq.com/developer)

• • Configure your webhook using the following URL: https://apipub.firstbasehq.com/scim/v2/Users
  • Data passed should include:
    • First Name
    • Last Name
    • Email
    • Country (in ISO 2 format)
    • Full Address - Needed if automatic packages will be used
    • Department - Needed for package assignment
    • Start Date - Needed to ensure we deliver on time.
  • In addition, you can filter on your side for other types of data.
    • For example:
      • Employee Type - Only send us information from employees you wish to create. If you don't want to create interns, for example, you can skip them by filtering out by employment type before using the webhook option. 

FAQ

Offboarding

• When will the offboarding webhooks trigger?

  As soon as we receive the event.

• Will I receive a notification after offboarding succeeds?

  Yes, you will receive an email to inform you that it succeeded.

• What if something goes wrong (example: I used a wrong employee email)

  We’ll send you an email to inform you that offboarding this person failed and that you’ll need to do it in the Firstbase application directly.

• Do I need to pass the Authorization header?

  Yes as we use secure webhooks only for integrating with webhooks.

• What if my API key gets leaked?

  You’ll need to delete your API key in the Firstbase app, then create a new one and update your webhook setup.

Onboarding

• When will the onboarding webhook trigger?

  As soon as we receive the event.

• Can you automatically assign a package?

  Not yet. We'll make this available soon.