Event Triggers

Filter for webhooks that are assigned to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Filter for webhooks that are assigned to this Buyer.

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Filter for webhooks that are assigned to this Schedule Action.

• Must be a valid foreign key reference to an Schedule Action. Refer to: /api/docs/1.0/schedule_actions

When does this trigger fire?

• Must be one of: agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.

Return records matching these ids.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Return the next page of results.

• Must be a number.

How many results to return per page. The default is 25.

• Must be a number.

Date formatted like 2016-01-01 12:25:15 -0500

• Must be a String

Date formatted like 2016-01-01 12:25:15 -0500

• Must be a String

Search for any record that matches this text

• Must be a String

Date ranges will be parsed using this time zone.

• Must be a valid time zone. See the list of valid time zones.

Must be any combination of:

• id
• legacy_id
• type
• uuid
• created_at
• updated_at
• deleted_at
• user_updated_at
• routes_show_path
• routes_edit_path
• external_record_id
• name
• context_menu_name
• trigger_type
• trigger_duration
• tier
• company_id
• offer_id
• offer_name
• schedule_action_id
• sortable_order
• outgoing_url_ids
• token_value_map_ids
• buyer_id
• traffic_source_id
• buyer_group_id
• call_router_id
• global_company_id
• buyer_name
• traffic_source_name
• buyer_group_name
• trigger_call_status
• cache_success_for_seconds
• webhook_body_success_path
• webhook_body_success_match
• webhook_body_success_operator
• webhook_path_number
• connected_duration_seconds
• webhook_path_duration
• webhook_path_name
• webhook_path_revenue
• webhook_response_success_codes
• webhook_path_buyer_name
• webhook_path_external_id
• buyer_answered_with_contact_field_ids
• webhook_contains_many_buyers
• webhook_path_buyers
• template_description
• template_enabled
• template_tier
• template_copy_on_company_create
• call_router_answer_id
• schedule_id
• webhook_action_ids
• token_value_map_group_ids
• record_token_filter_id
• record_token_filter_data_count
• record_token_filter_data
• record_token_additional_id
• record_token_additional_data_count
• record_token_additional_data
• webhook_manual_fire_ids

• Must be a String

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Assign the webhook to your company to have it fire on all calls.

• Must be a valid foreign key reference to an Company. Refer to: /api/docs/1.0/companies

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Filter for webhooks that are assigned to this Buyer.

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Filter for webhooks that are assigned to this Buyer Group.

• Must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups

Filter for webhooks that are assigned to this Traffic Source.

• Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Filter for webhooks that are assigned to this Call Flow.

• Must be a valid foreign key reference to an Call Flow. Refer to: /api/docs/1.0/call_routers

Assign the record to this Schedule Action.

• Must be a valid foreign key reference to an Schedule Action. Refer to: /api/docs/1.0/schedule_actions

When does this trigger fire?

• Must be one of: agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.

How many seconds must pass for the trigger to fire?

• Must be a decimal number.

Restrict which call statuses fire the webhook. Leave blank to fire regardless of status. live only fires while the call is in progress, ended only fires after the call has completed.

• Must be a String

Wait to fire the webhook until the buyer has been connected with the caller for this many seconds. If the call ends before that much time has passed, the webhook does not fire. Leave blank to fire as soon as the buyer connects.

• Must be a decimal number.

How long, in seconds, to cache a successful response from the webhook before checking it again.

• Must be a decimal number.

The order global webhooks fire in, from lowest to highest; webhooks assigned to a Buyer, Offer, etc are always tier 0. Set this below 0 to fire before other webhooks in your account. Only applies when global_company_id is set.

• Must be a decimal number.

Fire only after the buyer has answered and all of these Contact Fields have values.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Map lead data to custom values by assigning these Token Value Map Groups to the webhook.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Assign filters to the object by passing an array of key:value pairs

• Must be a valid list of filters. Example filters:
  "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

• Must be a valid list of tokens. Example tokens:
  buyer_interest:loan,another_token:value

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

• Must be a decimal number.

Assign the webhook to your company to have it fire on all calls.

• Must be a valid foreign key reference to an Company. Refer to: /api/docs/1.0/companies

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Filter for webhooks that are assigned to this Buyer.

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Filter for webhooks that are assigned to this Buyer Group.

• Must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups

Filter for webhooks that are assigned to this Traffic Source.

• Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Filter for webhooks that are assigned to this Call Flow.

• Must be a valid foreign key reference to an Call Flow. Refer to: /api/docs/1.0/call_routers

Assign the record to this Schedule Action.

• Must be a valid foreign key reference to an Schedule Action. Refer to: /api/docs/1.0/schedule_actions

When does this trigger fire?

• Must be one of: agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.

How many seconds must pass for the trigger to fire?

• Must be a decimal number.

Restrict which call statuses fire the webhook. Leave blank to fire regardless of status. live only fires while the call is in progress, ended only fires after the call has completed.

• Must be a String

Wait to fire the webhook until the buyer has been connected with the caller for this many seconds. If the call ends before that much time has passed, the webhook does not fire. Leave blank to fire as soon as the buyer connects.

• Must be a decimal number.

How long, in seconds, to cache a successful response from the webhook before checking it again.

• Must be a decimal number.

The order global webhooks fire in, from lowest to highest; webhooks assigned to a Buyer, Offer, etc are always tier 0. Set this below 0 to fire before other webhooks in your account. Only applies when global_company_id is set.

• Must be a decimal number.

Fire only after the buyer has answered and all of these Contact Fields have values.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Map lead data to custom values by assigning these Token Value Map Groups to the webhook.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Assign filters to the object by passing an array of key:value pairs

• Must be a valid list of filters. Example filters:
  "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

• Must be a valid list of tokens. Example tokens:
  buyer_interest:loan,another_token:value

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

• Must be a decimal number.

The human friendly name of this webhook.

• Must be a String

Assign the webhook to this SMS Flow to have it fire on that flow’s messages.

• Must be a valid foreign key reference to an SMS AI Flow. Refer to: /api/docs/1.0/text_message_flows

Assign the webhook to this Call Flow Answer to have it fire when that answer is used.

• Must be a valid foreign key reference to an Call Router Answer. Refer to: /api/docs/1.0/call_router_answers

Assign the webhook to your company to have it fire on all calls.

• Must be a valid foreign key reference to an Company. Refer to: /api/docs/1.0/companies

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Filter for webhooks that are assigned to this Buyer.

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Filter for webhooks that are assigned to this Buyer Group.

• Must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups

Filter for webhooks that are assigned to this Traffic Source.

• Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Filter for webhooks that are assigned to this Call Flow.

• Must be a valid foreign key reference to an Call Flow. Refer to: /api/docs/1.0/call_routers

Assign the record to this Schedule Action.

• Must be a valid foreign key reference to an Schedule Action. Refer to: /api/docs/1.0/schedule_actions

When does this trigger fire?

• Must be one of: agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.

How many seconds must pass for the trigger to fire?

• Must be a decimal number.

Restrict which call statuses fire the webhook. Leave blank to fire regardless of status. live only fires while the call is in progress, ended only fires after the call has completed.

• Must be a String

Wait to fire the webhook until the buyer has been connected with the caller for this many seconds. If the call ends before that much time has passed, the webhook does not fire. Leave blank to fire as soon as the buyer connects.

• Must be a decimal number.

How long, in seconds, to cache a successful response from the webhook before checking it again.

• Must be a decimal number.

The order global webhooks fire in, from lowest to highest; webhooks assigned to a Buyer, Offer, etc are always tier 0. Set this below 0 to fire before other webhooks in your account. Only applies when global_company_id is set.

• Must be a decimal number.

Fire only after the buyer has answered and all of these Contact Fields have values.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Map lead data to custom values by assigning these Token Value Map Groups to the webhook.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Assign filters to the object by passing an array of key:value pairs

• Must be a valid list of filters. Example filters:
  "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

• Must be a valid list of tokens. Example tokens:
  buyer_interest:loan,another_token:value

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

• Must be a decimal number.