Webhook - Frequently Asked Questions

General

1. Can I temporarily pause my integrations?

Yes, you can click "Stop" next to any of your workflows and restart it when you like!

Any employee that you onboard/offboard while the integration is stopped, may need to be created manually. The integration will still attempt to onboard/offboard employees based on the trigger conditions specified under each workflow (e.g. start date for new hires and effective termination date for offboardings). However, there is a risk we don't offboard/onboard someone if the integration is stopped and re-started. 

2. How do I know if an Integration ran successfully?

To know if an integration ran successfully, there's three ways:

• Check the latest sync timestamp under your specific integration flow.
• Check the Firstbase App to see if an employee was onboarded, offboarded or updated successfully.
• Check the email we send out with results from each specific webhook sync.

3. What are the available "Integration Field" options when customizing my integration?

There's several integration field options you can use when customizing your integration. They include:

4. How do I use multiple attributes to configure my package mapping?

You can map your packages using multiple attributes by adding conditions. For example, let's say you want to assign a "Customer Success" package based on the employee's country being US or UK and department being Customer Success. Here's how you'd set it up:

• Group Type would = Department
• Group Name would = Customer Success
• Country would be US or UK
• Package would be set to "Customer Success"

Note: When setting up country values please follow standard standard 2 character ISO country codes. More info here -> https://www.iban.com/country-codes.

5. What operators are available and how do they work?

In general, you can map packages using the six available operators:

• = Allows for a unique value. 
  • Example: "DEPARTMENT" = "Engineering" 
• ≠ Allows for a unique value.
  • Example: "DEPARTMENT" ≠ "Engineering" 
• IN - Allows for comma separated values. 
  • Example: "DEPARTMENT" IN "Engineering" 
• NOT IN - Allows for comma separated values
  • "Employment Type" NOT IN "Engineering" 
• LIKE - Allows for comma separated values. Useful when you have small different variations for a given field. Like Sales - Contractor; Engineering - Contract; Operations - Contractor...
  
  • Example: "Employment Type" LIKE "Contractor"
• NOT LIKE - Allows for comma separated values. Useful when you have small different variations for a given field. Like Sales - Contractor; Engineering - Contract; Operations - Contractor...
  • Example: "Employment Type" NOT LIKE "Contractor"

All conditions are AND conditions, meaning we'll consider all when assigning a package. There's no OR conditions today.

6. What options can I use to map my departments to packages?

To map packages to departments, we use two fields on our side called "Group Type" and "Group Name". Here's how both work:

Group Type is the name of the field we should be looking at. For webhook requests this would be your departments.

Group Name is the actual value for this field per employee. For example: Marketing, Operations, Engineering, etc. 

When setting up your integration, map both group type and group name so we know the exact values to look for. 

7. I want to use a custom field to onboard/offboard certain employees or map my packages in Firstbase. Can I do this?

Yes. There’s two options here:

• • For your onboarding integration only, you can add a custom field in your webhook request called “Firstbase” which can have two values: True or False. We’ll only onboard employees that have the Firstbase = True flag.
  • We can work with you to use additional custom fields in your webhook request to define customization options in your onboarding setup.  
    • Under the available integration fields, there's three fields called "Custom 1", "Custom 2", and "Custom 3"
    • We can map any of these fields to a field from your HRIS. 
    • We'll need to work with you to map it and ensure we are getting this information when the data syncs. 
    • If you are interested in exploring this option, please reach out to your CSM and we’ll schedule time with you to configure it. 

8. I have a custom need or separate question, how can I get help?

Please contact your CSM so he can share your request with the product and engineering team.