Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.fathom.ai/external/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "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_with_me_external_recordings"
  ]
}'
{
  "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"
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Include your API key in the X-Api-Key header of every request.

Body

application/json
​
destination_url
string<uri>
required

The URL to send the webhook to.

Example:

"https://example.com/webhook"

​
triggered_for
enum<string>[]
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:
[
  "my_recordings",
  "my_shared_with_team_recordings",
  "shared_with_me_external_recordings"
]
​
include_action_items
boolean
default:false

Include the action items for each meeting.

Example:

true

​
include_crm_matches
boolean
default:false

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

Example:

true

​
include_summary
boolean
default:false

Include the summary for each meeting.

Example:

true

​
include_transcript
boolean
default:false

Include the transcript for each meeting.

Example:

true

Response

The created webhook.

​
id
string
required
Example:

"ikEoQ4bVoq4JYUmc"

​
url
string<uri>
required
Example:

"https://example.com/webhook"

​
secret
string
required

The secret used to verify the webhook signature.

Example:

"whsec_x6EV6NIAAz3ldclszNJTwrow"

​
created_at
string<date-time>
required

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

Example:

"2025-06-30T10:40:46Z"

​
include_transcript
boolean
required
Example:

true

​
include_crm_matches
boolean
required
Example:

true

​
include_summary
boolean
required
Example:

true

​
include_action_items
boolean
required
Example:

true

​
triggered_for
enum<string>[]
required
Example:
[
  "my_recordings",
  "my_shared_with_team_recordings",
  "shared_external_recordings"
]
⌘I