How-to: Fetching Webhooks

When to use this

Use this when you need to read back your account’s webhook configuration — for example, to display a “manage webhooks” screen in your own app, confirm a webhook’s current events/active state before deciding whether to call updateWebhook, or grab an id to pass into deleteWebhook or the delivery logs query.

Restricted to the Admin/Owner of your Hireflix account, same as creating a webhook.

List all webhooks

Don’t forget to update the Hireflix API Key in the headers.

Explanation

• id – the webhook’s unique identifier, needed for updateWebhook, deleteWebhook, and the delivery-logs query.
• url – the callback endpoint Hireflix POSTs events to.
• events – the event types this webhook is currently subscribed to.
• active – whether the webhook is currently enabled.
• external – an optional identifier you can set for your own third-party integration bookkeeping.
• owner / company – the user and company IDs associated with the webhook.

Example Response

{
  "data": {
    "webhooks": {
      "list": [
        {
          "id": "68ff5ed8b07cc148bddcae02",
          "url": "https://your-callback-url",
          "events": ["interview.finish", "interview.create"],
          "active": true,
          "external": null,
          "owner": "63d00b73df403de202d97e73",
          "company": "68b43e38b19cf131a17c543f"
        }
      ]
    }
  }
}

Get a single webhook

If you already have the id (e.g. saved from when you created it), you can fetch just that one webhook instead of listing all of them.

Example Response

{
  "data": {
    "webhooks": {
      "get": {
        "id": "68ff5ed8b07cc148bddcae02",
        "url": "https://your-callback-url",
        "events": ["interview.finish", "interview.create"],
        "active": true,
        "external": null,
        "owner": "63d00b73df403de202d97e73",
        "company": "68b43e38b19cf131a17c543f"
      }
    }
  }
}

Learn next?

Let’s learn how to update a webhook.