Param name |
Description
Validations
|
---|---|
offer_id Optional |
Filter for webhooks that are assigned to this Offer.
|
buyer_id Optional |
translation missing: en.api.outgoing_webhooks.buyer_id
|
schedule_action_id Optional |
Filter for webhooks that are assigned to this Schedule Action.
|
trigger_type Optional |
When does this trigger fire?
|
ids Optional |
Return records matching these ids.
|
page Optional |
Return the next page of results.
|
per_page Optional |
How many results to return per page. The default is 25.
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
fulltext Optional |
Search for any record that matches this text
|
time_zone Optional |
Date ranges will be parsed using this time zone.
|
columns Optional |
Specify the columns you would like returned by the API for a given resource.
Limiting the columns can significantly increase API response time since only the requested data will be processed.
columns=uuid,number,created_at
Must be any combination of:
|
root Optional |
Pass
|
Param name |
Description
Validations
|
---|---|
global_company_id Optional |
Assign the webhook to your company to have it fire on all calls.
|
offer_id Optional |
Assign the record to this Offer.
|
buyer_id Optional |
translation missing: en.api.outgoing_webhooks.buyer_id
|
call_router_id Optional |
translation missing: en.api.outgoing_webhooks.call_router_id
|
schedule_action_id Optional |
Assign the record to this Schedule Action.
|
trigger_type Optional |
When does this trigger fire?
|
trigger_duration Optional Blank Value Allowed |
How many seconds must pass for the trigger to fire?
|
sortable_order Optional Blank Value Allowed |
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
|
Param name |
Description
Validations
|
---|---|
global_company_id Optional |
Assign the webhook to your company to have it fire on all calls.
|
offer_id Optional |
Assign the record to this Offer.
|
buyer_id Optional |
translation missing: en.api.outgoing_webhooks.buyer_id
|
call_router_id Optional |
translation missing: en.api.outgoing_webhooks.call_router_id
|
schedule_action_id Optional |
Assign the record to this Schedule Action.
|
trigger_type Optional |
When does this trigger fire?
|
trigger_duration Optional Blank Value Allowed |
How many seconds must pass for the trigger to fire?
|
sortable_order Optional Blank Value Allowed |
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
|
name Required |
The human friendly name of this webhook.
|
Param name |
Description
Validations
|
---|---|
global_company_id Optional |
Assign the webhook to your company to have it fire on all calls.
|
offer_id Optional |
Assign the record to this Offer.
|
buyer_id Optional |
translation missing: en.api.outgoing_webhooks.buyer_id
|
call_router_id Optional |
translation missing: en.api.outgoing_webhooks.call_router_id
|
schedule_action_id Optional |
Assign the record to this Schedule Action.
|
trigger_type Optional |
When does this trigger fire?
|
trigger_duration Optional Blank Value Allowed |
How many seconds must pass for the trigger to fire?
|
sortable_order Optional Blank Value Allowed |
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
|