Webhooks

Create a webhook

Create a webhook to receive new meeting content. At least one of include_transcript, include_crm_matches, include_summary, or include_action_items must be true.

post/webhooks

Request

Base URL
https://api.fathom.ai/external/v1
URL
https://api.fathom.ai/external/v1/webhooks
Auth
- API key in header X-Api-Key
- or HTTP bearer

Request body

destination_urlstring uri required

The URL to send the webhook to.

include_action_itemsboolean

Include the action items for each meeting.

include_crm_matchesboolean

Include CRM matches for each meeting. Only returns data from your or your team's linked CRM.

include_summaryboolean

Include the summary for each meeting.

include_transcriptboolean

Include the transcript for each meeting.

triggered_forstring[] required

You must send at least one of the following types of recordings to trigger on.

my_recordings: Your private recordings, as well as those you've shared with individuals. (On Team Plans, this excludes recordings you've shared with any teams.)
shared_external_recordings: Recordings shared with you by other users. (For Team Plans, this does not include recordings shared by other users on your Team Plan.)
my_shared_with_team_recordings: (Team Plans only). All recordings that you have shared with other teams (e.g. Marketing or Sales). Recordings you've shared with individuals but not with teams are not included.
shared_team_recordings: (Team Plans only) All recordings you can access from other users on your Team Plan, whether shared with you individually or with your team.

Example request

{
  "destination_url": "https://example.com/webhook",
  "include_action_items": true,
  "include_crm_matches": true,
  "include_summary": true,
  "include_transcript": true,
  "triggered_for": [
    "my_recordings",
    "my_shared_with_team_recordings",
    "shared_external_recordings"
  ]
}

Response

The created webhook.

idstring required

urlstring uri required

secretstring required

The secret used to verify the webhook signature.

created_atstring date-time required

The date and time the webhook was created in ISO 8601 format.

include_transcriptboolean required

include_crm_matchesboolean required

include_summaryboolean required

include_action_itemsboolean required

triggered_forstring[] required

Example response

{
  "id": "ikEoQ4bVoq4JYUmc",
  "url": "https://example.com/webhook",
  "secret": "whsec_x6EV6NIAAz3ldclszNJTwrow",
  "created_at": "2025-06-30T10:40:46Z",
  "include_transcript": true,
  "include_crm_matches": true,
  "include_summary": true,
  "include_action_items": true,
  "triggered_for": [
    "my_recordings",
    "my_shared_with_team_recordings",
    "shared_external_recordings"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.