Docs

Webhook event

A sourced candidate opted out

POSTcandidate.opted_out

Sent once when a person Alfa sourced for a linked job asks Alfa to stop contacting them, for example by replying to an outreach email. Alfa has already stopped its outreach to them. It carries every identifier Alfa holds, so you can mark the person as not to be contacted in your own systems.

Alfa sends this event to your webhook endpoint as a signed POST. How to verify and acknowledge webhooks

Headers

  • Alfa-Signaturestringrequired

    `t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">`, keyed with the endpoint's signing secret. Reject a request whose signature does not match or whose timestamp is more than 5 minutes from your clock.

Payload

  • idstringrequired

    The event id. Deliveries can repeat; ignore an id you have already processed.

  • type"candidate.opted_out"required

    Sent once when a person Alfa sourced for a linked job asks Alfa to stop contacting them, for example by replying to an outreach email. Alfa has already stopped its outreach to them. It carries every identifier Alfa holds, so you can mark the person as not to be contacted in your own systems.

  • apiVersion"v1"required

    The API version the payload follows.

  • occurredAtstringrequired

    When the event happened.

  • organizationIdstringrequired

    The company the event belongs to (its Company ID).

  • jobIdinteger | nullrequired

    Alfa's id for the job.

  • externalJobIdstring | nullrequired

    The ATS job the Alfa job is linked to.

  • candidateobjectrequired

    The person who opted out, with every identifier Alfa holds.

    Show fields
    • candidateIdstringrequired

      Alfa's id for the sourced candidate.

    • firstNamestring | nullrequired

      First name.

    • lastNamestring | nullrequired

      Last name.

    • emailstring | nullrequired

      The email address they opted out from.

    • phonestring | nullrequired

      Phone number, when known.

    • linkedinUrlstring | nullrequired

      LinkedIn profile URL, when known.

  • optedOutAtstringrequired

    When they opted out.

Responses

  • 200Any 2xx status acknowledges the event. Anything else, a redirect or no answer within 10 seconds is retried with exponential backoff for 24 hours.