GettingDocs
Guide · Crelate

Your team

YOUR ATS

Crelate

Connect Crelate with an API key, write chase rules, and see how documents are filed to the candidate.

How it works
Create an API key

In Crelate, go to Settings → API and create a key, ideally for a dedicated integration user such as “GettingDocs”.

Connect Crelate

Crelate connects with an API key. Two things need to be true on the Crelate side first:

  • The account is on Crelate’s Business plan or above. Essentials doesn’t include the API.
  • The user whose key you use has API access. If they aren’t a Crelate admin, an admin has to switch it on for them.
Use a dedicated integration user. Crelate keys belong to a person, and every file and note Gettingdocs adds appears in Crelate as that person. A user called something like “Gettingdocs” makes it obvious which files came in automatically.
  1. In Crelate, go to Settings → API and create a key for that user.
  2. In Gettingdocs, go to Settings → Integrations, paste it into the Crelate card and click Connect.
In the app: Settings → Integrations
GettingDocs Settings

On connect we read your record statuses, tags, custom fields, users and attachment types, so your rules can pick from real lists rather than typed guesses. If Crelate won’t let us read your statuses, the connection is refused, because statuses are how we know who must not be contacted.

We register for Crelate’s contact notifications ourselves, so there’s nothing to set up on the Crelate side. Crelate’s own guidance is that integrations check for changes on a schedule, so every rule is also checked every fifteen minutes, whatever notifications arrive.

Crelate chase rules

Open Settings → Integrations → Manage and click New rule. Crelate lets an integration choose candidates by four things, and a rule can use any mix of them:

Writing a rule, then previewing it
GettingDocs Crelate auto-chase

Tags

Candidates carrying any of the tags you pick.

Statuses

Candidates in any of the record statuses you pick.

Jobs

Candidates on any of the jobs you pick. Open jobs are listed by default; closed ones are a click away.

Owners

Candidates owned by any of the users you pick.

Within one list, any pick will do: two tags means either tag. Across lists, all of them have to match. Crelate doesn’t let integrations filter on custom fields, so those can’t decide who is chased, but they can decide what for.

For the documents, either chase everyone for one fixed set, map the values of a custom field to your document types, or read it from their tags: a “Needs DBS” tag can mean “ask for a DBS certificate”. Unmapped and empty values fall back to the set you nominate, as they do for Recruit CRM.

Preview and Run now work exactly as described above, and a rule only considers candidates changed after it was made.

Nobody in a status whose contact option is No or Limited is ever messaged, on any channel. There’s nothing to configure. Crelate’s API has no email opt-out, so to stop someone being contacted, move them to such a status.

Filing to Crelate

Documents are attached to the candidate’s Crelate contact, under the attachment type whose name matches the document type. A passport lands under Passport if you have that type.

Where documents land in Crelate
Crelate Candidates Sarah Jones

If no attachment type matches, the file is still attached, just untyped. Integrations can’t create attachment types in Crelate, so add the ones you want there for the tidiest filing. Files over 25 MB aren’t uploaded.

With the note option on, Amy adds one note to the contact once everything is in. Like the files, it’s posted as the user who made the API key.

Gettingdocs reads contacts and attaches files and notes. It never creates, edits or deletes a contact, and never changes a status.