---
title: "GET /webhooks"
method: GET
path: "/webhooks"
tags: ["webhooks"]
---

# GET /webhooks

`GET /webhooks`

Get a list of all of your webhooks

## Response `200`

Successful response

- Webhook[]
  - `id` string, uuid
  - `createdAt` string, date-time
  - `url` string, uri
  - `trigger` union — Which actions in your Heartbeat community should trigger this webhook. See the Webhooks page to learn more about each action
    - UserJoinWebhookAction
      - `name` 'USER_JOIN', required
    - UserUpdateWebhookAction
      - `name` 'USER_UPDATE', required
    - GroupJoinWebhookAction
      - `name` 'GROUP_JOIN', required
      - `filter` object
        - `groupID` string, uuid, required
    - AbandonedInvitationLinkWebhookAction
      - `name` 'ABANDONED_CART', required
      - `filter` object
        - `invitationLinkID` string, uuid
        - `groupIDs` string[]
    - ThreadCreateWebhookAction
      - `name` 'THREAD_CREATE', required
      - `filter` object
        - `channelID` string, uuid, required
        - `triggerOnMove` boolean — If enabled, this webhook will trigger when threads are moved into the specified channel
    - MentionWebhookAction
      - `name` 'MENTION', required
      - `filter` object, required
        - `userSelection` object[], required
          - `id` string, uuid, required
          - `type` 'USER' | 'GROUP', required
        - `channelIDs` string[]
    - DirectMessageWebhookAction
      - `name` 'DIRECT_MESSAGE', required
      - `filter` object, required
        - `userID` string, uuid, required
    - CourseCompletedWebhookAction
      - `name` 'COURSE_COMPLETED', required
      - `filter` object
        - `courseID` string, uuid, required
    - EventCreateWebhookAction
      - `name` 'EVENT_CREATE', required
    - EventRSVPWebhookAction
      - `name` 'EVENT_RSVP', required
      - `filter` object
        - `userType` 'HEARTBEAT_USER' | 'GUEST'
        - `eventID` string, uuid
    - DocumentCreateWebhookAction
      - `name` 'DOCUMENT_CREATE', required

## Other responses

- `401` — API Key is missing or invalid

---

[API](https://skmtc.dev/heartbeat/apis/heartbeat-api.md) · [All operations](https://skmtc.dev/heartbeat/apis/heartbeat-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/heartbeat/heartbeat-api/revisions/6c3cf537d508/schema)