The API and webhooks
Admins create API keys in Settings → Integrations → API keys: name the key and choose Create key, and copy it, since it’s shown once. Webhooks, on the same page, send signed events such as application.received and opportunity.hired to a URL of yours.
API keys#
Step 1: Open Settings → Integrations → API keys.
Step 2: Enter a Key name, such as “Zapier”, and choose Create key.
Step 3: Copy the key now. It’s shown once.
The API covers postings, opportunities, contacts, stages and the workspace’s event stream, and other tools can send transcripts to POST /api/v1/transcripts. Each key is rate-limited per minute.
Webhooks#
Step 1: On the same page, under Webhooks, enter your endpoint’s URL.
Step 2: Optionally, filter the events, for example
application.received, opportunity.hired.Leave it empty to receive every event.
Step 3: Choose Add.
- Every delivery is signed: check the
X-Source-Signatureheader (HMAC-SHA256) before trusting it. - Events arrive at least once, in order for each endpoint, and failed deliveries are retried.
- Pause or resume an endpoint with its Active switch.
Read next
Was this helpful?
Still need help?
Someone on the OpenATS team will reply by email.