> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hotfix.jobs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Product noun is jobs.
> MCP at https://rest.hotfix.jobs/mcp is the hiring contract for agents. Clients sign in with Hotfix; API keys are for HTTP only.
> Do not invent unpublished REST or hiring stats. Webhooks are set up in the app; there is no REST route or MCP tool to manage them.
> Do not mention Greenhouse, Ashby, Quick Apply, or claim.
> Creating a draft, offer, or booking link does not send email.

# API and webhooks

> Create API keys, see the AI apps connected to Hotfix, and send hiring events to your own systems.

Open **Settings** > **API**. It sits under **Connections** in the settings sidebar. Owners and Admins see this page. It comes with a hosted plan. Without one, you see **Hosted hiring only** and a link to **View billing**.

The page has three tabs:

| Tab | Use it to |
| - | - |
| **Keys** | Create and revoke API keys for scripts |
| **Apps** | See and disconnect AI apps your team signed in to |
| **Webhooks** | Send hiring events, like a new application, to your own URL |

## Keys

An API key lets your own scripts read and change hiring data over HTTP. See [Authentication](/authentication) for what a key can call.

### Create a key

<Steps>
  <Step title="Name the key">
    On the **Keys** tab, type a name in **Key name**. Pick one that says where
    the key is used.
  </Step>

  <Step title="Create it">Click **Create key**.</Step>

  <Step title="Copy the key">
    **Copy this key** opens. Click the copy button next to the key. This is the
    only time it is shown, so store it somewhere safe before you close the
    window.
  </Step>
</Steps>

If you lose a key, revoke it and create a new one. A company can have up to 20 keys.

### The key list

| Column | Shows |
| - | - |
| **Name** | The name you gave the key |
| **Key** | The start of the key, so you can tell keys apart |
| **Created** | When the key was made |

### Revoke a key

Click **Revoke** on the key's row, then **Revoke** again to confirm. Anything using the key stops working right away.

## Apps

The **Apps** tab lists AI apps, like Claude, ChatGPT, Cursor, or Codex, that someone on your team connected by signing in with Hotfix. To connect one, see [Get started](/hiring-mcp/get-started).

As an Owner or Admin, you see every app connected to your company.

| Column | Shows |
| - | - |
| **App** | The app's name |
| **Person** | Who connected it. Shows when the list includes someone else's app. |
| **Access** | **Read and write** or **Read only**, the level picked at sign-in |
| **Last used** | When the app last used Hotfix, or when it connected if it hasn't been used |

### Disconnect an app

Click **Disconnect** on the app's row, then **Disconnect** again to confirm. The app loses access right away. To use it again, someone has to sign in again.

## Webhooks

A webhook sends hiring events to a URL you own as they happen. See [Webhooks](/webhooks) for what each delivery contains, how to check the signature, and how retries work.

### Add a webhook

<Steps>
  <Step title="Start a new webhook">
    On the **Webhooks** tab, click **New webhook**.
  </Step>

  <Step title="Enter the URL">
    In **Endpoint URL**, enter the address that should get events. It must start
    with `https://`.
  </Step>

  <Step title="Pick events">
    Under **Events**, keep **All events** to get every event, including ones
    added later. Or uncheck it and pick the events you want.
  </Step>

  <Step title="Add it">Click **Add webhook**.</Step>

  <Step title="Copy the signing secret">
    **Copy this signing secret** opens. Click the copy button and give the
    secret to whoever runs the endpoint. This is the only time it is shown.
  </Step>
</Steps>

A company can have up to 10 webhooks. When you reach 10, **New webhook** is turned off.

### Events you can pick

| Group | Events |
| - | - |
| **Applications** | **Application received** |
| **Interviews** | **Interview booked**, **Interview rescheduled**, **Interview moved by candidate**, **Interview canceled** |
| **Feedback** | **Feedback added**, **Panel feedback complete** |
| **Offers** | **Offer sent**, **Offer accepted**, **Offer declined** |
| **Jobs** | **Job listed**, **Job closed** |

### The webhook list

| Column | Shows |
| - | - |
| **Endpoint** | The URL |
| **Events** | **All events**, the one event picked, or how many events are picked |
| **Last delivery** | Whether the last event got through, its response code, and when it was sent |

Hover the mark in **Last delivery** to see what it means:

| Mark | Meaning |
| - | - |
| **Delivered** | Your endpoint accepted the event |
| **Retrying** | It didn't get through yet. Hotfix tries again. |
| **Failed** | Hotfix gave up on this event |
| **Not sent yet** | Nothing has been sent to this webhook |

### Edit a webhook

Click a webhook's row to open it. Change the **Endpoint URL** or the **Events**, then click **Save**. The signing secret stays the same.

### Rotate the secret

Open the webhook and click **Rotate secret**. A new secret shows once. Copy it. Deliveries sign with the new secret right away, so update your endpoint at the same time.

### Send a test event

Open the webhook and click **Send test event**. Hotfix sends a test event to the URL and tells you whether it was delivered, with the response code, or why it failed.

### Recent deliveries

Open the webhook to see **Recent deliveries**, newest first, up to 20. Each line shows the mark, the event, how many tries it took when more than one, and when it was sent.

### Remove a webhook

Open the webhook and click **Remove**, then **Remove** again to confirm. Hotfix stops sending to that URL right away.

## Related

* [Authentication](/authentication)
* [Hiring MCP: Get started](/hiring-mcp/get-started)
* [Webhooks](/webhooks)
* [Integrations](/help/integrations)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.