Webhook Example: Employee Invited

When creating a new employee, optionally you can send an invitation to create an account in Factorial.

When?

When creating a new employee, optionally you can send an invitation to create an account in Factorial. If you send an invitation, this event gets triggered.

Click on the create new employee

On the create employee form, select Send invitation.... After submitting the form, the webhook will get triggered.

How?

Example curl to subscribe.

curl --request POST \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data ' { "type": "employee_invited", "target_url": "https://foo.com/webhooks/employee_invited" } '

What?

What does this webhooks send in the payload.

{ "id": 52, "first_name": "Bob", "last_name": "Macri", "email": "bob@company.com", "invited_on": "2021-10-22" }

Why?

Why would I subscribe to this event?

  • Send an email from another platform to users that get invited to Factorial.
  • Create a Zapier.com automation with employees.
  • Create a user in another platform or application that, on webhooks triggered, will use the api to fetch all employee info and create the user.
  • Create access info for a user in an external access platform or device.