From 9a4299b345938639807dac7485bae1ce5bcdc263 Mon Sep 17 00:00:00 2001 From: Harry Hunt <30357282+developingharry@users.noreply.github.com> Date: Tue, 27 Aug 2019 13:28:55 +0100 Subject: [PATCH 1/5] Fix broken link to next page (#19) --- pages/custom-connectors/methods.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/custom-connectors/methods.md b/pages/custom-connectors/methods.md index eaaeb4b67..b60ab0dd5 100644 --- a/pages/custom-connectors/methods.md +++ b/pages/custom-connectors/methods.md @@ -17,4 +17,4 @@ tags: [connector-creation] * **RequestFormat **/ **ResponseFormat **– this contains the request or response message format Fields. Each Field has ConnectorField, SystemField, and DisplayName. ConnectorField is the field name used in the connector. If a field is inside an array, it needs to be defined as \[Array\].Field. Multiple-dimension arrays can be defined as \[Array1\].\[Array2\].Field, etc. What if there is a field called \[Array2\].Field inside an Array1? We use \[Array1\].\\Array2.Field\\ to explicitly define Array2.Field as a field name. SystemField is the system name for the field. We use PascalCasing for system names as a convention. DisplayName is the name shown in the Cyclr UI. * **Fields **– the names of fields to use in the API call. Fields must have been defined in the connector to appear here. Name, TriggerName, IdentifierKey, and HumanReadableKey are needed. -[Take a Look at Custom Connector Examples](./examples) +[Take a Look at Custom Connector Examples](./custom-connector-examples) From 27b30e6196e58acc92a15d76b63d2e8b285e0c8a Mon Sep 17 00:00:00 2001 From: Harry Hunt <30357282+developingharry@users.noreply.github.com> Date: Tue, 27 Aug 2019 13:29:42 +0100 Subject: [PATCH 2/5] fix broken link to next page (#20) --- pages/custom-connectors/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/custom-connectors/examples.md b/pages/custom-connectors/examples.md index 6d901fae0..e8de11841 100644 --- a/pages/custom-connectors/examples.md +++ b/pages/custom-connectors/examples.md @@ -217,4 +217,4 @@ The other example is taken from the ZohoCRM connector. You can see how parameter } {% endraw %} -[Learn About Custom Connector Fields](./fields) +[Learn About Custom Connector Fields](./custom-connector-fields) From 53d82eaa6cf8f80bf564e466a1ee1bd4877c2dbb Mon Sep 17 00:00:00 2001 From: Harry Hunt <30357282+developingharry@users.noreply.github.com> Date: Tue, 27 Aug 2019 13:50:23 +0100 Subject: [PATCH 3/5] fix broken link to next page (#21) --- pages/custom-connectors/properties.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/custom-connectors/properties.md b/pages/custom-connectors/properties.md index 413118c2a..4fbb54400 100644 --- a/pages/custom-connectors/properties.md +++ b/pages/custom-connectors/properties.md @@ -54,4 +54,4 @@ Your connector needs an icon. * Minimum: square @ 256px x 256px * 24-bit PNG on a transparent background -[Learn About Custom Connector Parameters & Triggers ](./parameters-and-triggers) +[Learn About Custom Connector Parameters & Triggers ](./custom-connectors-parameters-triggers) From ba8bc5f6f67b9a6310a5eb9870d2d7784d64f330 Mon Sep 17 00:00:00 2001 From: Ruixiao Yu Date: Wed, 28 Aug 2019 16:32:44 +0100 Subject: [PATCH 4/5] Update call-a-connector-method.md --- pages/embedding/call-a-connector-method.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/pages/embedding/call-a-connector-method.md b/pages/embedding/call-a-connector-method.md index b40ea016f..efb76dd6e 100644 --- a/pages/embedding/call-a-connector-method.md +++ b/pages/embedding/call-a-connector-method.md @@ -89,3 +89,22 @@ Authorization: Bearer ********************************************************** ] } ``` + +If the method you are calling requires any field or parameter to be passed to the third-party application, they should be included in your request body. + +#### Request + +```http +POST https://yourCyclrInstance/v1.0/account/connectors/{account connector ID}/methods/{method ID} +Authorization: Bearer **************************************************************** +Content-Type: application/json + +{ + "Parameters": { + "400123": "true" + }, + "Fields": { + "500123": "test@example.com" + } +} +``` From 5d9c4b6a44a5aad4883efc6109ed9b6d2fe221c1 Mon Sep 17 00:00:00 2001 From: Harry Hunt <30357282+developingharry@users.noreply.github.com> Date: Fri, 30 Aug 2019 13:14:27 +0100 Subject: [PATCH 5/5] fix link to API endpoints guide --- pages/embedding/api-authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/embedding/api-authentication.md b/pages/embedding/api-authentication.md index f6c31d1ec..ec115410e 100644 --- a/pages/embedding/api-authentication.md +++ b/pages/embedding/api-authentication.md @@ -88,4 +88,4 @@ To authenticate your requests you need to include the access token in the Author Authorization: Bearer {AccessToken} ``` -[View Cyclr’s API Endpoints](./api-endpoints) +[View Cyclr’s API Endpoints](./cyclr-api-endpoints)