| Contact us |
|---|
| We are preparing the connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). with this application for you. In the meantime, please create your own connection. |
With Deel modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. in Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., you can manage the recordsIn Boost.space, a record is a single data entry within a module, like a row in a database. For example, a contact in the Contacts module or a task in the Tasks module. in your Deel account.
To use the Deel modules, you must have the account in Deel. You can create an account at app.deel.com/signup.
Refer to the Deel API documentation for a list of available endpoints.
To establish the connection, you must:
-
Note: Only the Deel API key type of connection requires obtaining the API key.
To obtain your API key from your Deel account:
-
Log in to your Deel account.
-
Go to the App Store section and click Developer Center.
-
In API access tokenA secure code used to authenticate and authorize access to API endpoints, enabling users to connect with third-party applications., select which access token you want to generate: for an organization or for a person.
-
Click Generate New Token.
-
In the Type a labelIn Boost.space, a label is a tag that can be added to items within a module. It's a flexible tool used to categorize and organize data, making it easier to customize workflows and processes. to name your token field, enter a name for the access token. Click Next.
-
Select the needed scopes and click Generate. Refer to the list of modules to check which scopes you need to select.
-
Copy the API key value shown and store it in a safe place.
You will use this value in the API Key field in Boost.space Integrator.
To establish the connection in Boost.space Integrator:
-
Log in to your Boost.space Integrator account, add a Deel modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. to your scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., and click Create a connection.
Note: If you add a module with an
instanttag, click Create a webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers., then Create a connection. -
In Connection type, select the type of the connection:
-
Deel OAuth
-
Deel API Key
-
-
Optional: In the Connection name field, enter a name for the connection.
-
If you chose the Deel API Key connection type, in the API Key field, enter the API key copied above.
-
In Environment, choose the staging that you want to connect to.
-
Optional: Switch on the Show advanced settings toggle, enter your custom appCreate your own custom apps to be used in the integrator engine and share them with users in your organization. client credentials, and select the needed scopes. For more information, refer to the Deel help documentation.
If requested, use the following Redirect URI when creating your custom app:
https://integrator.boost.space/oauth/cb/deel.Note: To create the Deel OAuth type of connection, you need to select the
organizations:readscope. -
Click Save.
-
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your scenario and add more Deel modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
This app uses webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. to triggerThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. a scenario when an event occurs instantly. All webhook modules have an instant tag next to their name.
To set up a webhook, follow these steps:
-
Add an Deel instant module to your scenario and click Add.
-
Optional: Enter a name for the webhook in the Webhook name field.
-
Select the corresponding connection for the webhook in the Connection field.
-
In the Event type, select the type of the event that you want to trigger the webhook.
-
Optional: In the Name field, enter a name for the webhook.
-
Optional: In the Description field, enter a description for the webhook.
-
Click Save.
Build Deel ScenariosA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive.
After connecting the app, you can perform the following actions:
With the help of these modules, you can manage records in your Deel account.
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when selected event occurs.
|
Webhook |
Select a webhook for the event you want to watch. |
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
This app uses webhooks to trigger a scenario when an event occurs instantly. All webhook modules have an When you create a Deel webhook in Boost.space Integrator, it is attached automatically. |
Lists records by search criteria.
|
Connection |
|
|
RecordIn Boost.space, a record is a single data entry within a module, like a row in a database. For example, a contact in the Contacts module or a task in the Tasks module. Type |
Select the record type to search. |
|
Record Details |
Enter or map the information of the record you want to create into the fields that appear. The fields are dependent upon the selected Record Type. |
|
Limit |
Enter the maximum number of results to be worked with during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Required scopes: timesheets:read, contracts:read, tasks:read, people:read, global-payroll:read, candidates:read.
Creates a new record.
|
Connection |
|
|
Record Type |
Select the record type to create. |
|
Record Details |
Enter or map the information of the record you want to create into the fields that appear. The fields are dependent upon the selected Record Type. |
Requires scopes: global-payroll:read, global-payroll:write, timesheets:read, timesheets:write, contracts:read, contracts:write, tasks:read, tasks:write, people:read, candidates:read, candidates:write.
Retrieves the details of a record by its ID.
|
Connection |
|
|
Record Type |
Select the record type to get. |
|
Record ID |
Enter the ID of the record you want to get. |
Required scopes: timesheets:read, contracts:read, global-payroll:read, people:read.
Updates a record by its ID.
|
Connection |
|
|
Record Type |
Select the record type to update. |
|
Record Details |
Enter or map the information of the record you want to update into the fields that appear. The fields are dependent upon the selected Record Type. |
|
Record ID |
Enter the ID of the record you want to update. |
Requires scopes: global-payroll:read, global-payroll:write, timesheets:read, timesheets:write, contracts:read, contracts:write, tasks:read, tasks:write, people:read, candidates:read, candidates:write.
Deletes a record by its ID.
|
Connection |
|
|
Record Type |
Select the record type to delete. |
|
ID |
Enter the ID of the record you want to delete. |
|
Reason |
Enter the reason for the record deletion. |
Required scopes: timesheets:read, timesheets:write, contracts:read, global-payroll:read, tasks:read, tasks:write.
Performs an arbitrary authorized API call.
|
Connection |
|
|
URL |
Enter a path relative to Read more about the base URL. Refer to the Deel API documentation for a list of available endpoints. |
|
Method |
Select or map the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|
Headers |
Enter or map the desired request headers. |
|
Query String |
Enter or map the request query string. |
|
Body |
Enter the body content for your API call. |