AttendBeacon
Åbn arbejdsområdet

API-reference

Automation

Subscriptions made by Power Automate, Zapier and other platforms that subscribe through the API.

List subscriptions

GET/hooks

Lists the workspace's automation subscriptions, newest first. Their callback addresses are never shown.

Scopes
webhooks:read

    Svar

    • 200 The subscriptions. HookList
      Felter
      • dataHook[]

        The subscriptions.

        Vis felterne
        • idstring (uuid)

          The subscription's id.

        • eventstring

          The event type it receives.

        • eventIdstring (uuid)

          The one event it listens to; every event when empty.

        • clientstring

          The platform that made it: powerautomate, zapier or make.

        • activeboolean

          Whether it is sent anything.

        • createdUtcstring (date-time)

          When it was made, in UTC.

    • 401 invalidKey, keyExpired, keyRevoked.
    • 403 missingScope.
    • 429 rateLimited.

    Afvisninger

    invalidKey keyExpired keyRevoked rateLimited missingScope

    Forespørgsel

    curl "https://attendbeacon.com/api/v1/hooks" \
      -H "Authorization: Bearer $ATTENDBEACON_KEY"
    401 invalidKey, keyExpired, keyRevoked.
    JSON
    {
      "type": "https://attendbeacon.com/developers/errors#invalidKey",
      "title": "No working API key",
      "status": 401,
      "detail": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key.",
      "instance": "/api/v1/hooks",
      "code": "invalidKey",
      "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
      "error": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key."
    }

    Subscribe to an event type Ændrer data

    POST/hooks

    Subscribes a callback address to one event type, for every event of the workspace or one of them. The answer's Location header is the address to DELETE to unsubscribe. Each delivery is a plain JSON body: id, type, timestamp and what happened. A callback that answers 410 Gone is unsubscribed, and every subscription goes when its key is revoked or expires. Needs webhooks:write (keys made before 15 October 2026: webhooks:read) and the scopes of what the type delivers.

    Scopes
    webhooks:write
    • Send en Idempotency-Key, så gentagne forsøg er sikre. →

    Parametre

    header

    • Idempotency-Keystring

      A key of your own, such as a UUID, so a retry after a lost connection is answered with the first answer instead of doing it twice. Kept 24 hours.

    Body NewHookWithType

    The callback, the event type and optionally the event.

    • urlstringpåkrævet

      The https address to call with each event.

    • eventstringpåkrævet

      The event type to receive.

      En af: attendee.registered, attendee.updated, attendee.cancelled, attendee.erased, order.paid, checkin.created, feedback.given, lead.captured, certificate.issued, content.published, stay.requested, stay.assigned, stay.changed, stay.cancelled, member.joined, member.left, travel.changed, claim.submitted, claim.approved, claim.paid, shift.signed_up, shift.dropped

    • eventIdstring (uuid)

      Only this event of the workspace; every event when absent.

    Svar

    • 201 Subscribed. Location names the subscription. Hook
      Felter
      • idstring (uuid)

        The subscription's id.

      • eventstring

        The event type it receives.

      • eventIdstring (uuid)

        The one event it listens to; every event when empty.

      • clientstring

        The platform that made it: powerautomate, zapier or make.

      • activeboolean

        Whether it is sent anything.

      • createdUtcstring (date-time)

        When it was made, in UTC.

    • 400 invalidRequest, tooManyHooks, invalidIdempotencyKey.
    • 401 invalidKey, keyExpired, keyRevoked.
    • 403 missingScope.
    • 404 eventNotFound.
    • 409 idempotencyKeyInUse.
    • 422 idempotencyKeyReused.
    • 429 rateLimited.

    Afvisninger

    invalidKey keyExpired keyRevoked rateLimited missingScope eventNotFound invalidRequest tooManyHooks idempotencyKeyInUse idempotencyKeyReused invalidIdempotencyKey

    Forespørgsel

    curl -X POST "https://attendbeacon.com/api/v1/hooks" \
      -H "Authorization: Bearer $ATTENDBEACON_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{}'
    400 invalidRequest, tooManyHooks, invalidIdempotencyKey.
    JSON
    {
      "type": "https://attendbeacon.com/developers/errors#invalidRequest",
      "title": "The request is not valid",
      "status": 400,
      "detail": "A field or parameter is missing or wrong; errors names each, with what is wrong.",
      "instance": "/api/v1/hooks",
      "code": "invalidRequest",
      "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
      "errors": [
        {
          "field": "startDate",
          "message": "startDate is a date such as 2026-11-12."
        }
      ],
      "error": "A field or parameter is missing or wrong; errors names each, with what is wrong."
    }

    Subscribe to one event type Ændrer data

    POST/hooks/{eventType}

    Subscribes a callback address to the event type in the path. The same as posting to the hooks list with the type in the body; the AttendBeacon connector uses one path per trigger.

    Scopes
    webhooks:write
    • Send en Idempotency-Key, så gentagne forsøg er sikre. →

    Parametre

    sti

    • eventTypestringpåkrævet

      The event type to receive.

      En af: attendee.registered, attendee.updated, attendee.cancelled, attendee.erased, order.paid, checkin.created, feedback.given, lead.captured, certificate.issued, content.published, member.joined, member.left, stay.requested, stay.assigned, stay.changed, stay.cancelled, shift.signed_up, shift.dropped, travel.changed, claim.submitted, claim.approved, claim.paid

    header

    • Idempotency-Keystring

      A key of your own, such as a UUID, so a retry after a lost connection is answered with the first answer instead of doing it twice. Kept 24 hours.

    Body NewHook

    Where to send what happens, and for which event.

    • urlstringpåkrævet

      The https address to call with each event.

    • eventIdstring (uuid)

      Only this event of the workspace; every event when empty.

    Svar

    • 201 Subscribed. Location names the subscription. Hook
      Felter
      • idstring (uuid)

        The subscription's id.

      • eventstring

        The event type it receives.

      • eventIdstring (uuid)

        The one event it listens to; every event when empty.

      • clientstring

        The platform that made it: powerautomate, zapier or make.

      • activeboolean

        Whether it is sent anything.

      • createdUtcstring (date-time)

        When it was made, in UTC.

    • 400 invalidRequest, tooManyHooks, invalidIdempotencyKey.
    • 401 invalidKey, keyExpired, keyRevoked.
    • 403 missingScope.
    • 404 eventNotFound.
    • 409 idempotencyKeyInUse.
    • 422 idempotencyKeyReused.
    • 429 rateLimited.

    Afvisninger

    invalidKey keyExpired keyRevoked rateLimited missingScope eventNotFound invalidRequest tooManyHooks idempotencyKeyInUse idempotencyKeyReused invalidIdempotencyKey

    Forespørgsel

    curl -X POST "https://attendbeacon.com/api/v1/hooks/attendee.registered" \
      -H "Authorization: Bearer $ATTENDBEACON_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{}'
    400 invalidRequest, tooManyHooks, invalidIdempotencyKey.
    JSON
    {
      "type": "https://attendbeacon.com/developers/errors#invalidRequest",
      "title": "The request is not valid",
      "status": 400,
      "detail": "A field or parameter is missing or wrong; errors names each, with what is wrong.",
      "instance": "/api/v1/hooks/{eventType}",
      "code": "invalidRequest",
      "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
      "errors": [
        {
          "field": "startDate",
          "message": "startDate is a date such as 2026-11-12."
        }
      ],
      "error": "A field or parameter is missing or wrong; errors names each, with what is wrong."
    }

    Get a subscription

    GET/hooks/{hookId}

    Gets one automation subscription of the workspace, without its callback address.

    Scopes
    webhooks:read

      Parametre

      sti

      • hookIdstring (uuid)påkrævet

        The subscription's id, from the Location header of the answer that made it.

      Svar

      • 200 The subscription. Hook
        Felter
        • idstring (uuid)

          The subscription's id.

        • eventstring

          The event type it receives.

        • eventIdstring (uuid)

          The one event it listens to; every event when empty.

        • clientstring

          The platform that made it: powerautomate, zapier or make.

        • activeboolean

          Whether it is sent anything.

        • createdUtcstring (date-time)

          When it was made, in UTC.

      • 401 invalidKey, keyExpired, keyRevoked.
      • 403 missingScope.
      • 404 notFound.
      • 429 rateLimited.

      Afvisninger

      invalidKey keyExpired keyRevoked rateLimited missingScope notFound

      Forespørgsel

      curl "https://attendbeacon.com/api/v1/hooks/5a7c9e1b-3d5f-4a6b-8c9d-0e1f2a3b4c5d" \
        -H "Authorization: Bearer $ATTENDBEACON_KEY"
      401 invalidKey, keyExpired, keyRevoked.
      JSON
      {
        "type": "https://attendbeacon.com/developers/errors#invalidKey",
        "title": "No working API key",
        "status": 401,
        "detail": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key.",
        "instance": "/api/v1/hooks/{hookId}",
        "code": "invalidKey",
        "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
        "error": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key."
      }

      Unsubscribe Ændrer data

      DELETE/hooks/{hookId}

      Removes an automation subscription, so nothing more is sent to its callback. A key removes its own as it may make them; another key's need webhooks:write.

      Scopes
      webhooks:write

        Parametre

        sti

        • hookIdstring (uuid)påkrævet

          The subscription's id, from the Location header of the answer that made it.

        Svar

        • 204 Removed.
        • 401 invalidKey, keyExpired, keyRevoked.
        • 403 missingScope.
        • 404 notFound.
        • 429 rateLimited.

        Afvisninger

        invalidKey keyExpired keyRevoked rateLimited missingScope notFound

        Forespørgsel

        curl -X DELETE "https://attendbeacon.com/api/v1/hooks/5a7c9e1b-3d5f-4a6b-8c9d-0e1f2a3b4c5d" \
          -H "Authorization: Bearer $ATTENDBEACON_KEY"
        401 invalidKey, keyExpired, keyRevoked.
        JSON
        {
          "type": "https://attendbeacon.com/developers/errors#invalidKey",
          "title": "No working API key",
          "status": 401,
          "detail": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key.",
          "instance": "/api/v1/hooks/{hookId}",
          "code": "invalidKey",
          "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
          "error": "No key was sent, or it is not one this platform made. Send it as Authorization: Bearer abk_... or in X-Api-Key."
        }

        Guiderne og dette site er på dit sprog. API-referencens egne beskrivelser er på engelsk, ligesom API'et selv.