{"_id":"558dbbe3beb7c719007f63ae","project":"558d9c32beb7c719007f6319","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"558d70614cd25f0d00b7eba4","parentDoc":null,"__v":39,"category":{"_id":"5908d1f64f544425002b6aae","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T18:37:42.174Z","from_sync":false,"order":9,"slug":"legacy-documentation","title":"Legacy Documentation"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-26T20:53:55.954Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":21,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use the Distributor Form webhook to send disposition information for data collection or CRM/Help Desk integration.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8SShKhvQ9mGv5lAFaHZN_1436842179_news.png\",\n        \"1436842179_news.png\",\n        \"128\",\n        \"128\",\n        \"#ac9337\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe Distributor Form or the Distributor Notes Form webhook enables users to send disposition information, captured by a Call Distributor Agent, to a web service for data collection or CRM/Help Desk integration.\n\nThis type of webhook can have its own webhook configuration. The Distributor Form webhook GET request is sent to a user's web service when an Agent-Panel user clicks the **Save Form** option.\n## Distributor Form Setup \nThe following instructions describe how to access the configuration for the Distributor Form webhook:\n1. Click the **Call Management** option. \n2. Go to **Distributor Forms**.\n3. Build Distributor Form.\n4. Go to **Submit Data to Custom URL** and click \"Configure.\"\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/EusBMbmQR1CPmvVFJR2K_Screen%20Shot%202015-08-03%20at%204.56.54%20PM.png\",\n        \"Screen Shot 2015-08-03 at 4.56.54 PM.png\",\n        \"756\",\n        \"385\",\n        \"#69969e\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n5. Enter the URL, page, and static parameters to be sent.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cKigmSrHQW6gFrjUerbq_Screen%20Shot%202015-08-03%20at%204.57.51%20PM.png\",\n        \"Screen Shot 2015-08-03 at 4.57.51 PM.png\",\n        \"506\",\n        \"137\",\n        \"#5e8487\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Question Parameter Names\nThe data from the Distributor Form submission to be sent to a web server is contained in the question parameter names.\n\nThe user can specify the labels for the form question and response parameters sent via the form webhook request.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/LR5LsirhRqVewLfohOWg_Screen%20Shot%202015-08-03%20at%204.55.47%20PM.png\",\n        \"Screen Shot 2015-08-03 at 4.55.47 PM.png\",\n        \"427\",\n        \"124\",\n        \"#649494\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe following are a list of pre-named system parameters that are included with request:\n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"DESCRIPTION\",\n    \"h-0\": \"NAME\",\n    \"0-0\": \"Agent ID\",\n    \"1-0\": \"Ani\",\n    \"2-0\": \"Dnis\",\n    \"3-0\": \"SID\",\n    \"0-1\": \"The Agent responsible for submitting the form.\",\n    \"1-1\": \"The caller ID of an inbound call.\",\n    \"2-1\": \"The number dialed for a phone call.\",\n    \"3-1\": \"The unique session ID for the phone call.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Agent Experience\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c3v5vLJUR7ijFrcZKRpw_Screen%20Shot%202015-08-03%20at%204.50.57%20PM.png\",\n        \"Screen Shot 2015-08-03 at 4.50.57 PM.png\",\n        \"286\",\n        \"712\",\n        \"#5dba45\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"The example above illustrates how the Distributor Form appears on an Agent Panel.\",\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"distributor-form-1","type":"basic","title":"DISTRIBUTOR FORM"}

Use the Distributor Form webhook to send disposition information for data collection or CRM/Help Desk integration.

The Distributor Form or the Distributor Notes Form webhook enables users to send disposition information, captured by a Call Distributor Agent, to a web service for data collection or CRM/Help Desk integration.

This type of webhook can have its own webhook configuration. The Distributor Form webhook GET request is sent to a user's web service when an Agent-Panel user clicks the Save Form option.

Distributor Form Setup

The following instructions describe how to access the configuration for the Distributor Form webhook:

  1. Click the Call Management option.
  2. Go to Distributor Forms.
  3. Build Distributor Form.
  4. Go to Submit Data to Custom URL and click "Configure."
  1. Enter the URL, page, and static parameters to be sent.

Question Parameter Names

The data from the Distributor Form submission to be sent to a web server is contained in the question parameter names.

The user can specify the labels for the form question and response parameters sent via the form webhook request.

The following are a list of pre-named system parameters that are included with request:

NAME
DESCRIPTION

Agent ID

The Agent responsible for submitting the form.

Ani

The caller ID of an inbound call.

Dnis

The number dialed for a phone call.

SID

The unique session ID for the phone call.

Agent Experience

The example above illustrates how the Distributor Form appears on an Agent Panel.