Class: Fathom::Webhook

Inherits:
Resource show all
Defined in:
lib/fathom/resources/webhook.rb

Instance Attribute Summary

Attributes inherited from Resource

#attributes, #rate_limit_info

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#[], #[]=, all, client, create, #delete, #id, #initialize, #inspect, #method_missing, #reload, resource_name, #respond_to_missing?, retrieve, search, #to_h, #to_json, #update

Constructor Details

This class inherits a constructor from Fathom::Resource

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Fathom::Resource

Class Method Details

.resource_pathObject



5
# File 'lib/fathom/resources/webhook.rb', line 5

def self.resource_path = "webhooks"

Instance Method Details

#active?Boolean

Check if webhook is active

Returns:

  • (Boolean)


11
# File 'lib/fathom/resources/webhook.rb', line 11

def active? = self["active"] == true || self["status"] == "active"

#include_action_items?Boolean

Check if action items are included in webhook payload

Returns:

  • (Boolean)


28
# File 'lib/fathom/resources/webhook.rb', line 28

def include_action_items? = self["include_action_items"] == true

#include_crm_matches?Boolean

Check if CRM matches are included in webhook payload

Returns:

  • (Boolean)


31
# File 'lib/fathom/resources/webhook.rb', line 31

def include_crm_matches? = self["include_crm_matches"] == true

#include_summary?Boolean

Check if summary is included in webhook payload

Returns:

  • (Boolean)


25
# File 'lib/fathom/resources/webhook.rb', line 25

def include_summary? = self["include_summary"] == true

#include_transcript?Boolean

Check if transcript is included in webhook payload

Returns:

  • (Boolean)


22
# File 'lib/fathom/resources/webhook.rb', line 22

def include_transcript? = self["include_transcript"] == true

#secretObject

Get the webhook secret (if available)



14
# File 'lib/fathom/resources/webhook.rb', line 14

def secret = self["secret"]

#triggered_forObject

Get triggered_for configuration Possible values: “my_recordings”, “shared_external_recordings”,

"my_shared_with_team_recordings", "shared_team_recordings"


19
# File 'lib/fathom/resources/webhook.rb', line 19

def triggered_for = self["triggered_for"]

#urlObject

Get the webhook URL



8
# File 'lib/fathom/resources/webhook.rb', line 8

def url = self["url"]