Skip to main content
All CollectionsAPI and webhooksWebhooks
Getting started with webhooks
Getting started with webhooks
Updated over 7 months ago

⚠️ Available in Professional package. Interested? Please e-mail us at sales@peopleforce.io to find out more.

Webhooks allow external services to be notified when certain events happen. When the specified events happen, we’ll send a POST request to each of the URLs you provide.

Setting up a webhook

Go to Settings -> Webhooks -> Add new webhook.

You will see 3 fields:

  • Name - name your webhook so you can find it later

  • Payload URL - it's the URL of the server that will receive the webhook POST requests.

  • Topics - events that you would like to be notified of happening; you can choose multiple.

Once all fields are filled you are ready to go! Save your new webhook and try it out.

Webhook execution history

Want to make sure your webhook was sent?
Navigate to Settings -> Webhooks -> and select your webhook name. This will open the history of webhook executions. By clicking on the delivery name, you can view the raw data that was sent.

Troubleshooting

Did something go wrong? Maybe you did not receive your webhook or received not what you expected?

  1. Check your Payload URL, make sure it's correct, and that server that will be receiving webhook supports webhooks.

  2. Check the history of your webhook runs. If the webhook was delivered repeat step 1 and proceed to step 3.

200 Success

Webhook was delivered

404 Not Found

The resource could not be found. Please check that your request is referring to an existing object.

500 Internal Server Error

There was a problem with our server. Try again later or contact support to learn more.

3. Check your recipient server to be up and running and not to have any issues.

If neither of these helps feel free to contact us.



Did this answer your question?