Integrations
Recruit Suite connects to outside tools in three ways: an e-signature service for offers, calendar invitations for interviews, and hooks developers can use to send recruiting events elsewhere.
E-signature for offers
Section titled “E-signature for offers”Recruit Suite doesn’t talk to DocuSign, Dropbox Sign, Adobe Acrobat Sign or similar services directly. It sends offers to an adapter endpoint: a small web service you or your developer run, which passes the offer on to your signing provider and reports back.
What you need
Section titled “What you need”- An adapter endpoint on an HTTPS address.
- A shared secret of at least 24 characters, known to both your site and the adapter.
- Your WordPress site running on HTTPS.
- A valid email address on the candidate’s resume.
Connect the adapter
Section titled “Connect the adapter”- Open WP Job Portal → Recruiting Automation.
- Under E-signature webhook provider, enter the Adapter endpoint.
- Enter the Shared HMAC secret. Once saved, leave it blank to keep the current one.
- Tick Synchronize signed/declined callbacks to offer decisions if a signature should decide the offer.
- Select Save automation settings.
If the endpoint isn’t HTTPS or the secret is too short, the settings aren’t saved and you see Enter a valid HTTPS signing endpoint and a shared secret of at least 24 characters.
Send an offer for signature
Section titled “Send an offer for signature”On an approved or sent offer, select Send for e-signature. See Offers. Each offer can have only one open signature request at a time.
Recruit Suite posts JSON to the adapter with these fields:
| Field | Contents |
|---|---|
event |
offer.signature_requested |
signature_request_id, offer_id, application_id |
Recruit Suite’s IDs |
candidate |
name and email |
company, job, offer |
Company name, job title, offer title and expiry |
document_url |
A link to the offer PDF. It works for one hour. |
document_expires_at_utc |
When that link stops working |
callback_url |
Where the adapter reports status changes |
signature_algorithm |
HMAC-SHA256 |
The request carries an X-WPJP-Signature header: the HMAC-SHA256 of the request body, made with the shared secret.
The adapter must reply with a 2xx status and JSON containing external_id and an HTTPS signing_url. If it doesn’t, the request is marked failed and you see The e-signature provider did not accept this request.
On success, an approved offer becomes Sent, the candidate moves to the Offer stage, and the candidate sees Review and sign in their Candidate Portal.
Status callbacks
Section titled “Status callbacks”The adapter reports progress by posting JSON to the callback_url it was given. This is your site’s REST route wpjobportal-recruitsuite/v1/signature/callback, usually /wp-json/wpjobportal-recruitsuite/v1/signature/callback. Sign the body with the same X-WPJP-Signature header. Include:
signature_request_idexternal_idstatus:sent,viewed,signed,declinedorvoided
Callbacks with a wrong signature are refused. Once a request is signed, declined or voided, it can’t change again.
With Synchronize signed/declined callbacks to offer decisions on, signed moves a sent offer to Accepted and the candidate to Hired, and declined moves it to Declined. Each change is added to the candidate’s activity and the candidate gets an update.
Voiding
Section titled “Voiding”If someone declines or withdraws an offer by hand while a signature request is open, Recruit Suite first posts offer.signature_void_requested to the adapter, with the request’s IDs and the reason. The offer only changes if the adapter answers with a 2xx status.
Recent Signature Requests on the Recruiting Automation screen lists the latest requests and their status. Each offer also shows its Signature history.
Calendar invitations
Section titled “Calendar invitations”Interviews work with any calendar app that reads standard calendar files.
- Add to calendar (.ics) on a scheduled interview downloads a calendar file.
- Send calendar invitation emails an invitation to the candidate and the interviewer.
- With Automatically email calendar invitations on in Automation, invitations go out when an interview is scheduled or changed, and a cancellation goes out when it’s cancelled.
Later invitations for the same interview update the original event rather than adding a new one. Candidates can also add upcoming interviews to their calendar from the Candidate Portal.
Offer PDFs
Section titled “Offer PDFs”Download offer PDF on an approved offer creates a PDF letter from the offer record. Candidates can download their sent offer from the Candidate Portal. The same document is what the e-signature adapter receives.
Privacy tools
Section titled “Privacy tools”Recruit Suite adds its records to WordPress’s personal data export and erasure tools, such as team memberships, notes, tasks, scorecards, offers, notifications and candidate links. On erasure, a person’s recruiting records are anonymised or removed.
For developers
Section titled “For developers”Recruit Suite fires WordPress actions you can use to send events to other systems, for example:
wpjobportal_recruitsuite_notification_createdandwpjobportal_recruitsuite_candidate_notification_createdwpjobportal_recruitsuite_user_mentionedandwpjobportal_recruitsuite_task_assignedwpjobportal_recruitsuite_interview_scheduledandwpjobportal_recruitsuite_scorecard_savedwpjobportal_recruitsuite_offer_createdandwpjobportal_recruitsuite_offer_status_changedwpjobportal_recruitsuite_signature_status_changed
The wpjobportal_recruitsuite_notification_frequency filter changes how often a repeated reminder is sent, and wpjobportal_recruitsuite_bulk_actions adds bulk actions. See Hooks.