RecruitApp.ai Zapier API Documentation

Modified on Thu, 5 Dec, 2024 at 11:33 PM

This document outlines the Zapier API provided by RecrutApp.ai, detailing its endpoints, request formats, authentication mechanisms, and sample responses.

Base URL:

All API requests are sent to the following base endpoint:

https://zapierapi.recruitapp.ai

Authentication

All API endpoints require an API key and specific parameters for authentication.

Authentication Parameters:

Parameter	Type	Required	Description
`api_key`	String	Yes	The API key assigned to your account.
`recruitapp_url`	String	Yes	Subdomain of the RecruitApp instance to access.
`action`	String	Yes	Specifies the action to perform.
`event`	String	No	The event type for subscriptions.
`webhook_url`	String	No	The URL to which events should be sent.

Note: Unauthorized requests will return a 401 status code if api_key or recruitapp_url is invalid.

Endpoints

1. Authentication

Verifies the api_key and recruitapp_url and returns connection details.

Request:

{
  "api_key": "your_api_key",
  "recruitapp_url": "subdomain",
  "action": "authenticate"
}

Response:

{
  "status": "success",
  "message": "Authentication successful",
  "connection_name": "Your Department Name"
}

2. Subscribe

Subscribes to a specific event and stores the webhook URL.

Request:

{
  "api_key": "your_api_key",
  "recruitapp_url": "subdomain",
  "action": "subscribe",
  "event": "new_icard",
  "webhook_url": "https://your-webhook-url.com"
}

Response:

{
  "status": "success",
  "message": "Subscription successful",
  "action": "subscribe",
  "event": "new_icard",
  "webhook_url": "https://your-webhook-url.com"
}

3. Unsubscribe

Removes an event subscription based on the webhook URL.

Request:

{
  "api_key": "your_api_key",
  "recruitapp_url": "subdomain",
  "action": "unsubscribe",
  "event": "new_icard",
  "webhook_url": "https://your-webhook-url.com"
}

Response:

{
  "status": "success",
  "message": "Unsubscribe successful",
  "action": "unsubscribe",
  "event": "new_icard",
  "webhook_url": "https://your-webhook-url.com"
}

4. New Interest Card (new_icard)

Sends sample data for mapping.

Request:

{
  "api_key": "your_api_key",
  "recruitapp_url": "subdomain",
  "action": "new_icard"
}

Response:

[
  {
    "icard_id": "123",
    "applicant_type": "Police Officer",
    "status": "Pending",
    "date_received": "2024-11-01",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "(202) 555-1212",
    "email": "noemail@nodomain.com",
    "hiring_event": {
      "location_name": "Demo Police Academy",
      "location_address": "321 Main Street",
      "location_city": "Washington",
      "location_state": "DC",
      "location_zipcode": "20001",
      "hiring_event_date": "2024-11-01"
    },
    "recruiter": {
      "recruiter_firstname": "John",
      "recruiter_lastname": "Doe",
      "recruiter_email": "johndoe@noemail.com"
    }
  }
]

5. Event Reports

Post Event Report (Returns details of attended/missed events.)

Request (attended_event):

{
  "api_key": "your_api_key",
  "recruitapp_url": "subdomain",
  "action": "attended_event"
}

Response:

{
  "event_details": {
    "event_id": "1",
    "event_date": "2024-11-01",
    "attended_count": "5",
    "event_positions": "Police Officer, Cadet",
    "event_link": "https://your-site-url.com"
  },
  "location": {
    "location_name": "Demo Police Academy",
    "location_address": "321 Main Street",
    "location_city": "Washington",
    "location_state": "DC",
    "location_zipcode": "20001"
  },
  "interest_cards": [
    {
      "icard_id": "1",
      "applicant_type": "Police Officer",
      "status": "Attended",
      "first_name": "John",
      "last_name": "Doe"
    }
  ]
}

6. Sample Data Endpoints

Other data endpoints include:

rescheduled_icard
missed_event
archived_icard
kiosk_contact

Replace the action field with the respective endpoint action. Each request requires api_key and recruitapp_url.

Error Handling

Error Codes:

Code	Message	Description
400	Bad Request	Invalid parameters or missing fields.
401	Authentication Failed	`api_key` or `recruitapp_url` mismatch.
404	Request Invalid	Invalid action or unsupported event.
500	Internal Server Error	Server-side error during processing.

Notes

Ensure secure storage of your API key.
Test with authenticate before performing other actions.
Always include the recruitapp_url parameter to specify your subdomain.
Log all incoming and outgoing requests for troubleshooting purposes.

Feel free to use this documentation to integrate seamlessly with Zapier workflows.