Params

Param name
Description
outgoing_webhook_id
Optional

Filter for urls that are assigned to this webhook.

ids
Optional

Return records matching these ids.

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

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

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

  • Must be a number.

created_at_to
Optional

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

  • Must be String

created_at_from
Optional

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

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

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:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • name
  • outgoing_webhook_id
  • offer_id
  • remote_url
  • remote_method
  • sortable_order
  • post_body
  • post_headers
  • response_parser_ids
  • webhook_params_count
  • webhook_read_timeout
  • buyer_ping_parser_ids
  • outgoing_webhook_trigger_type
  • has_response_acceptance
  • token_value_map_group_ids
  • webhook_response_success_codes
  • webhook_body_success_path
  • webhook_body_success_match
  • cache_success_for_seconds
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data
  • Must be String

root
Optional

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


Params

Param name
Description
outgoing_webhook_id
Required

Assign the record to this Outgoing Webhook.

remote_url
Optional

Remote URL

  • Must be String

remote_method
Optional

Remote Method

  • Must be one of: get, post, post_body, post_api_v1, put, delete, patch.

post_body
Optional

POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}

  • Must be String

post_headers
Optional

POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json

  • Must be String

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.

  • Must be a decimal number.


Params

Param name
Description
outgoing_webhook_id
Required

Assign the record to this Outgoing Webhook.

remote_url
Optional

Remote URL

  • Must be String

remote_method
Optional

Remote Method

  • Must be one of: get, post, post_body, post_api_v1, put, delete, patch.

post_body
Optional

POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}

  • Must be String

post_headers
Optional

POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json

  • Must be String

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.

  • Must be a decimal number.


GET /api/v1/outgoing_webhook_urls/:id
Show the details of a webhook url


Params

Param name
Description
outgoing_webhook_id
Optional

Assign the record to this Outgoing Webhook.

remote_url
Optional

Remote URL

  • Must be String

remote_method
Optional

Remote Method

  • Must be one of: get, post, post_body, post_api_v1, put, delete, patch.

post_body
Optional

POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}

  • Must be String

post_headers
Optional

POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json

  • Must be String

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.

  • Must be a decimal number.