Depending on your integration needs, you might consider building a custom integration with Pinpoint. We offer three primary resources to support this: our API, webhooks, and SFTP file transfers. Before you start, check our Integrations page to see if an existing integration meets your requirements.
If building a custom integration yourself isn’t the right fit, we’ve partnered with several companies that specialize in creating tailored solutions. Reach out to your CSM to be connected with the right partner and receive pricing details.
How do I use the Pinpoint API?
Pinpoint API allows you to access resources directly from Pinpoint. We have a number of endpoints documented here. You can also use this help guide to create an API key. Applications, documents, and onboarding answers can all be accessed with our API.
How do I create a Webhook?
Webhooks in Pinpoint let you automate workflows by sending real-time notifications to your chosen endpoint whenever specific actions occur, such as a candidate applying for a role or a status update in your hiring process. This ensures seamless communication between Pinpoint and your external systems.
Navigate to Webhooks
Go to the Company Profile, and click on the Webhooks tab.
Create a New Webhook
To create a new webhook you will need a URL to point to. You can create a demo endpoint to accept webhooks at webhook.site.
Select an Event
Once you've created a Webhook, you can pick wich events to trigger on. If you scroll further down you'll also see an example of the payload sent, and have the ability to send a dummy request for testing. Common events to use include New Application, Offer Accepted, or Onboarding Completed.
How do I send an SFTP Report?
Any custom report in Pinpoint can be set up to be sent as CSV to an SFTP server. To start, you'll need to create your report first. Once created, follow these steps to setup up the file transfer.
Edit Schedule
Once you have a report built, click on the Edit Schedule button.
Add SFTP Schdule
Toggle the setting for the report to be regularly sent. Second, pick a time for the schedule; it can be sent daily, weekly, or monthly. Finally, select SFTP as the delivery type.
Fill in SFTP Info
Add the needed information for your SFTP server. Once completed click Save.
FAQs and Troubleshooting
How do I decide which integration method is best for my needs?
Depending on your needs, different approaches might be best. Below is a list of each approach and where it fits best:
API: This is best for getting the most data or in addition to the other approaches. It is also the only method for extracting documents (like offer letters, onboarding files, etc.) from the system.
Webhooks: Typically used in conjunction with the API, Webhooks are best for instant integration. They allow data to be sent as soon as an event happens in Pinpoint (like receiving an application, signing an offer letter, or completing onboarding).
SFTP: CSV files are great for periodic syncs between systems.
Are there any pre-built integrations available for common tools my team uses?
Yes, we have a number pre-built integrations you can use. You can find integration by going to the integration page in Pinpoint and searching for the platform you are looking for. Additionally, we have documentation here for several of our integrations.
