Skip to content
Get help now!
  • There are no suggestions because the search field is empty.

Setting up and managing APIs

In this article:

What is an API?

An API (Application Programming Interface) is like a personal messenger that helps your CareerPlug Partnership and your other systems talk to each other, allowing them to share data without having to access each other directly.

What are the benefits of using an API?

You may want to use an API for a variety of reasons, but primarily it allows you to build upon your CareerPlug account to work seamlessly with another system that may be more complicated than setting up an API.

Here are some use cases for when you might want to use an API:

  • Data Integration: APIs let CareerPlug communicate with a custom HR system, job board, or payroll software, eliminating manual data entry.
  • Custom Reporting: APIs allow you to pull your CareerPlug applicant data to create tailored dashboards or reports using third-party analytics tools.
  • Third-Party Integrations: Connect CareerPlug with third-party integrations as tools for assessments, communication (like Slack), or even CRM systems.

Who can use an API?

Anyone with access to CareerPlug's PartnerHub can use an API, whether you're a small business owner or have a technical team to assist you. PartnerHub makes setting up APIs simple!

Where do I manage my CareerPlug Partnership API?

You will manage your webhook from CareerPlug's PartnerHub.

How do I set up my CareerPlug Partnership API?

1. Click the plus sign icon (+).

2. Enter a Name for your API in the associated field.

3. Select your Partnership from the drop-down menu.

Note: There will only ever be one option available for your designated Partnership, which cannot be edited. The Partnership field may be pre-filled.

4. Click the Save button.

You'll be redirected to a page reflecting your Client ID, Client Secret Code, and Scopes. You can use these credentials to access the API and continue your build.

Never share the Client ID or Secret Code of your API with anyone. Sharing either piece of information will leave all of your data vulnerable.

Need help with your webhook?

If you encounter issues, contact our Technical Account Manager at TechAM@careerplug.com.