Core ConceptsIntegrations
Core Concepts

Integrations and Connections

Learn how to connect Xresume AI with third-party tools to enhance your recruitment workflow and automate data flow.

curl -X POST https://your-webhook-url.com/xresume \
  -H "X-Xresume-Signature: v1=abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "event": "resume.parsed",
    "data": { "resume_id": "res_123456" }
  }'

Overview

Xresume AI supports seamless integrations with popular HR tools, ATS systems, and automation platforms. These connections enable you to automate resume parsing, sync candidate data, and trigger actions across your workflow. Whether you use Zapier for no-code automations or direct API webhooks, Xresume AI makes it easy to extend your recruitment process.

Review the available integrations list to find the best fit for your stack. Start with pre-built connectors before custom webhooks.

Connect Xresume AI to leading tools without writing code. Use these pre-built integrations to import resumes, sync candidates, and automate notifications.

Setting Up Integrations

Follow these steps to connect Xresume AI with any supported platform.

Generate API Key

Navigate to your account settings in the Xresume AI dashboard.

# Find this in Settings > Integrations > API Keys
curl -X POST https://api.example.com/v1/integrations/keys \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"name": "Zapier Integration"}'

Copy the generated key securely.

Configure Third-Party App

In your target app (e.g., Zapier), add Xresume AI as a trigger or action.

Use the API key from the previous step.

Test the Connection

Run a test event, such as uploading a sample resume.

Verify data flows correctly in both directions.

Configuring Webhooks

Webhooks provide real-time notifications for events like new resume uploads or parsing complete.

Webhook Setup

  1. Go to Settings > Webhooks.
  2. Click Add Webhook.
  3. Enter your endpoint URL (e.g., https://your-webhook-url.com/xresume).
  4. Select events: resume.parsed, candidate.created.

Enable HMAC signature verification for security.

Sample Webhook Payload

{
  "event": "resume.parsed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "resume_id": "res_123456",
    "candidate": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "skills": ["React", "Node.js"]
    }
  }
}

Importing and Exporting Data

Exchange resume data with external services using our import/export APIs.

Key Parameters

path
filefile
Required

Resume file (PDF, DOCX).

query
formatstring

Output format: json (default), csv.

Export Example

const response = await fetch('https://api.example.com/v1/resumes/export?format=json', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
});
const resumes = await response.json();

Troubleshooting

  • Verify the webhook URL is publicly accessible.
  • Check event permissions in dashboard.
  • Review recent deliveries in Settings > Webhooks > Logs.

Common error: 502 Bad Gateway indicates server issues on your end.

Best Practices

  • Rotate API keys regularly.
  • Use least-privilege scopes for integrations.
  • Test webhooks in staging before production.

Explore the API Reference for advanced endpoints. Start with a free trial at app.xresume.ai/auth/sign-up.