Linking Deel as a source
This source is currently in alpha. The interface and available tables may change.
The Deel connector automatically pulls your Deel workforce and payroll data into the PostHog data warehouse.
Adding a data source
- Go to the sources tab of the data pipeline section in PostHog.
- Click + New source and then click Link next to Deel.
- You need a Deel API token. In your Deel admin console, go to Settings and create an organization API token. Enable the read scope for each dataset you want to sync (see required scopes below).
- Back in PostHog, enter the token in the API token field and click Next.
- Select the tables you want to sync, set the sync method and frequency, then click Import.
Once the syncs are complete, you can start using Deel data in PostHog.
Use an organization API token rather than a personal API token. Personal tokens expire when the user leaves the organization, which causes syncs to fail.
Available tables
| Table | Description | Sync method |
|---|---|---|
people | Employee and contractor records | Full refresh |
contracts | Contract details for workers | Full refresh |
invoices | Invoice records | Full refresh |
invoice_adjustments | Adjustments made to invoices | Full refresh |
Full refresh tables sync all records on each run. Deel's API doesn't expose updated-since filters for these resources.
Required scopes
Deel API tokens are scoped per dataset. Your token needs the read permission for each table you want to sync. If a scope is missing, that specific table fails with a permissions error while other tables continue to sync normally.
| Table | Required scope |
|---|---|
people | people:read |
contracts | contracts:read |
invoices | invoices:read |
invoice_adjustments | invoice_adjustments:read |
Configuration
| Option | Type | Required |
|---|---|---|
API token | password | Yes |
Supported tables
| Table | Description | Sync method | Incremental field | Primary key |
|---|---|---|---|---|
people | A worker in the organization — an employee or contractor managed in Deel. | Full refresh | — | — |
contracts | A work agreement between the organization and a worker in Deel. | Full refresh | — | — |
invoices | An invoice issued for a contract or payroll cycle in Deel. | Full refresh | — | — |
invoice_adjustments | An adjustment (bonus, deduction, expense, etc.) applied to a Deel invoice. | Full refresh | — | — |