Getting started - Enterprise
This guide is for medium and large companies that want to get started with Embloy. If you are a small or local business, please refer to the Small Business guide or contact us directly.
For those using an ATS with an existing Embloy integration, please consult this guide.
If your ATS provider is not yet supported, this guide will also cover how to set up custom webhooks.
Hey there! 👋 Welcome to Embloy! We are excited to have you on board. This guide will explain every step you need to take to integrate Embloy on your job page and make the most out of our platform.
Step 1: Create an account​
If you haven't already, you can create an Embloy account by visiting our registration page. You can also sign up using your Google, LinkedIn, Microsoft, or GitHub accounts.
After you have created an account, you will receive a confirmation email. Click on the link in the email to verify your account.
Step 2: Subscribe to Embloy​
Choose a plan and subscribe to Embloy. We partner up with Stripe to process payments, so you don't have to worry about us storing or processing any sensitive information.
Step 3: Create a client token​
Next, create a new client_token in the "secrets" tab of your Embloy Genius settings and save it in your backend's environment file.
The client_token defaults to a three-month expiration but can be extended up to one year. Post-expiration, a new token must be created and uploaded.
Step 4: Integrate Embloy into your page​
Server-side​
Use the client token to request a redirection URL from the Embloy API for applicants. This requires adding an endpoint to your backend, which can be done manually or via Embloy's SDKs.
The process involves two steps:
-
The "Apply with Embloy" button on your frontend triggers a call to your new endpoint, passing the job's posting ID.
e.g.,
<your-api>/<your-endpoint>?postingID=<your-posting-ID> -
Your endpoint uses the client token and job posting ID to either call our SDKs or this endpoint, returning a redirect link for the user.
If you use Rails, it could look like this:
client_token = ... # Retrieve client token for the employer/owner of this job posting
posting_id = params["postingID"] # The job's posting ID needs to be passed to this endpoint
# Call our SDK (or manually the api.embloy.com/api/v0/sdk/request/auth/token endpoint)
session = {mode: "your-ats-name", job_slug: posting_id}
client = Embloy::Client.new(client_token, session)
redirect_url = client.make_request
redirect_to redirect_url # Return the URL to which the user needs to be redirectedtipConsult our SDK documentation for more examples and details.
Client-side: The "Apply with Embloy" button​
Display the Embloy button on every job posting. When clicked, it should call the endpoint defined in Step 2.
A typical implementation might look like this, but for this part, you can think of an approach that works best for you:
const handleApplyClick = async () => {
try {
// Call your endpoint as defined in step 2
const response = await fetch('<your-api>/<your-endpoint>?postingID=<your-posting-ID>', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
});
// Redirect the user to the application portal
window.location.href = (await response.json()).url;
} catch (error) {
console.error('Error:', error);
}
};
The final step is to add the button to your UI that calls this action and looks like this one 👉
<button onClick={handleApplyClick}> <!-- Style this accordingly so that it fits within your UI -->
<img src="https://embloy.com/images/button-black_large.svg" style={{ width: "300px", height: "auto" }} />
</button>
When a candidate clicks on "Embloy Apply " on your page, they will be then redirected to Embloy's application portal.
Optional: Custom webhooks for unsupported ATS providers​
This section is only relevant, if you plan to synchronize incoming Embloy applications with other systems.
If your ATS provider is not yet supported, you can set up custom webhooks to integrate with Embloy, so that whenever a new Embloy application is received, we automatically forward it to your ATS.
- Register a new webhook in Embloy.
- Ensure the webhook payload includes essential details such as job ID, title, description, and any other pertinent information.
- Embloy will then automatically forward applications received for these jobs to the endpoint specified in the webhook configuration.
Conclusion​
- With Embloy integrated, applications submitted through Embloy will be directly visible in the recruiter portal, allowing you to screen applications and respond to candidates efficiently.
FAQ​
Why do I need to save a client token and make an API call using Embloy's SDKs before redirecting the user instead of just hardcoding a link to a job (e.g., embloy.com/apply?jobPostingId=...)?
There are two reasons for this:
- Security: We need to ensure that applications for a certain job are only submitted from a site where the employer has uploaded the application form (e.g., your job posting). For this, we need the client token.
- Request Authentication: We need to verify that a redirection to our portal has been done by an Embloy customer who is authorized for this action. Hence, to authenticate the request, you call our SDKs using your (secret) client token to return a (public and short-lived) request token which we then verify.
Do I need to use Embloy's SDKs?
No. You can use our open-source SDKs out of convenience, but if you don't want to, you can do it manually by calling this endpoint.
Can the Embloy button be integrated with mobile applications?
Yes. The process for integrating the Embloy button with mobile applications is similar to integrating it with a website, as described above. You need to implement the same features in your mobile application as you would for a website. You can either use our soon-to-be-released mobile SDKs or do it manually by calling this endpoint. If you need help with this, please contact us and we'll do our best to help.
Embloy doesn't provide an SDK for my backend framework. What should I do?
We try to provide SDKs for the most popular frameworks, but if we don't support yours yet, please contact us and we'll either create a new SDK or explain in detail how to do it manually using this endpoint.
Can I customize the look and feel of the Embloy button?
Currently, we offer a few default buttons, to accommodate for light and dark backgrounds. If you need a different style, please contact us and we'll do our best to help.
Is there a limit to the number of job postings I can create with Embloy?
The number of job postings you can create depends on the subscription plan you have chosen. Please refer to our subscription features for details on the job posting limits for each plan. If you need to increase your limit, you can upgrade your plan at any time from your account's billing settings.
Can I integrate Embloy with my existing HR software?
Yes, Embloy offers integration capabilities with various HR software solutions. If your HR software is not directly supported, you can use our API or set up custom webhooks to connect Embloy with your system. For more information on integrating Embloy with your HR software, please visit our integration documentation and the 'How to connect Embloy with your ATS' page.
What kind of support does Embloy offer?
Embloy provides multiple support channels to ensure you have the help you need. These include email support and a comprehensive documentation. For more complex issues or integration assistance, reach out to us and we'll do our best to help.
Any other questions or technical issues? Just reach out to us and we'll do our best to help.