Alfa

Webhooks

List webhook deliveries

GET/v1/integration/webhook-deliveries/page

Every delivery attempt to your endpoint, newest first, with the status your endpoint answered and how long it took. Bodies are not stored. Requires an API key with the `webhooks:manage` scope.

Requires an Alfa API key as a bearer token. How API keys work

Query parameters

  • limitstring

    How many results to return, from 1 to 100. Defaults to 25.

  • cursorstring

    The `nextCursor` of the previous page. Leave it out for the first page.

    at least 1 characters · at most 2048 characters

Headers

  • Alfa-Company-Idstring

    The Company ID of the company to act for. Required with a platform key, and that company must have authorized your platform; a company key acts for its own company and can leave it out.

Response body

  • dataobject[]required

    The results on this page.

    Show fields
    • deliveryIdintegerrequired

      The delivery attempt id.

    • eventIdstringrequired

      The event id; every attempt of one event shares it.

    • eventTypestringrequired

      The event type.

    • keyIdintegerrequired

      The API key whose endpoint was called.

    • companyIdstringrequired

      The company the event belongs to.

    • jobIdinteger | nullrequired

      The Alfa job, for candidate events.

    • candidateIdstring | nullrequired

      The candidate, for candidate events.

    • attemptintegerrequired

      The attempt number, from 1.

    • statusCodeinteger | nullrequired

      The status your endpoint answered with.

    • durationMsintegerrequired

      How long the request took.

    • errorstring | nullrequired

      Why the attempt failed, when it did.

    • succeededbooleanrequired

      Whether the attempt got a 2xx answer.

    • attemptedAtstringrequired

      When the attempt was made.

  • nextCursorstring | nullrequired

    Pass as `cursor` to read the next page; null on the last page.

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details