FRESHDESK CONNECTOR JSON'S

ImportAccountEntJSON

{
  "accountParams": {
    "connection": "acctAuth",
    "processingType": "SequentialAndIterative",
    "successResponses": {
      "statusCode": [
        200
      ]
    },
    "doNotChangeIfFailed": true,
    "statusAndThresholdConfig": {
      "accountsNotInImportAction": "Suspend",
      "accountThresholdValue": 1000,
      "deleteAccEntForActiveAccounts": true
    },
    "call": {
      "call1": {
        "callOrder": 0,
        "stageNumber": 0,
        "http": {
          "url": "https://localdomain.freshdesk.com/api/v2/agents",
          "httpHeaders": {
            "Authorization": "${access_token}",
            "Accept": "application/json"
          },
          "httpContentType": "application/json",
          "httpMethod": "GET"
        },
        "listField": "",
        "keyField": "accountID",
        "colsToPropsMap": {
          "accountID": "id~#~char",
          "name": "contact.email~#~char",
          "displayName": "contact.name~#~char",
          "customproperty1": "contact.job_title~#~char",
          "customproperty2": "contact.language~#~char",
          "customproperty3": "contact.mobile~#~char",
          "customproperty4": "contact.name~#~char",
          "customproperty5": "contact.phone~#~char",
          "customproperty6": "contact.time_zone~#~char",
          "customproperty7": "contact.created_at~#~char",
          "customproperty8": "contact.updated_at~#~char",
          "customproperty9": "contact.active~#~char",
          "customproperty13": "groups[0].name~#~char",
          "customproperty31": "STORE#ACC#ENT#MAPPINGINFO~#~char"
        }
      }
    }
  },
  "entitlementParams": {
    "connection": "acctAuth",
    "processingType": "SequentialAndIterative",
    "entTypes": {
      "groups": {
        "entTypeOrder": 0,
        "call": {
          "call1": {
            "callOrder": 0,
            "stageNumber": 0,
            "http": {
              "url": "https://localdomain.freshdesk.com/api/v2/admin/groups",
              "httpHeaders": {
                "Authorization": "${access_token}",
                "Accept": "application/json"
              },
              "httpContentType": "application/json",
              "httpMethod": "GET"
            },
            "listField": "",
            "keyField": "entitlementID",
            "colsToPropsMap": {
              "entitlementID": "id~#~char",
              "entitlement_value": "name~#~char",
              "description": "description~#~char",
              "customproperty1": "description~#~char",
              "customproperty2": "created_at~#~char",
              "customproperty3": "updated_at~#~char",
              "customproperty4": "group_type~#~char"
            },
            "disableDeletedEntitlements": true
          }
        }
      },
      "Role": {
        "entTypeOrder": 1,
        "call": {
          "call1": {
            "callOrder": 0,
            "stageNumber": 0,
            "http": {
              "url": "https://localdomain.freshdesk.com/api/v2/roles",
              "httpHeaders": {
                "Authorization": "${access_token}",
                "Accept": "application/json"
              },
              "httpContentType": "application/json",
              "httpMethod": "GET"
            },
            "listField": "",
            "keyField": "entitlementID",
            "colsToPropsMap": {
              "entitlementID": "id~#~char",
              "entitlement_value": "name~#~char",
              "customproperty1": "description~#~char",
              "customproperty2": "created_at~#~char",
              "customproperty3": "updated_at~#~char",
              "customproperty4": "agent_type~#~char"
            },
            "disableDeletedEntitlements": true
          }
        }
      }
    }
  },
  "acctEntParams": {
    "connection": "acctAuth",
    "entTypes": {
      "groups": {
        "call": {
          "call1": {
            "callOrder": 0,
            "stageNumber": 0,
            "processingType": "httpEntToAcct",
            "http": {
              "httpHeaders": {
                "Authorization": "${access_token}"
              },
              "url": "https://localdomain.freshdesk.com/api/v2/admin/groups/${id}/agents",
              "httpContentType": "application/json",
              "httpMethod": "GET"
            },
            "listField": "",
            "entKeyField": "entitlementID",
            "acctIdPath": "id",
            "acctKeyField": "accountID"
          }
        }
      }
    }
  }
}



CreateAccountJSON


{
  "accountIdPath": "call1.message.id",
  "responseColsToPropsMap": {
	"displayName": "call1.message.id~#~char"
  },
  "call": [
    {
      "name": "call1",
      "connection": "acctAuth",
      "url": "https://localdomain.freshdesk.com/api/v2/agents",
      "httpMethod": "POST",
      "httpParams": "{\"name\":\"${arsTasks?.accountName}\",\"email\":\"${user.email}\",\"ticket_scope\":1,\"language\":\"en\"}",
      "httpHeaders": {
        "Authorization": "${access_token}"
      },
      "httpContentType": "application/json",
      "successResponses": {
        "statusCode": [
          201,
          200
        ]
      }
    }
  ]
}


AddAccessJSON

{
  "call": [
    {
      "name": "groups",
      "connection": "acctAuth",
      "url": "https://localdomain.freshdesk.com/api/v2/admin/groups/${entitlementValue.entitlementID}/agents",
      "httpMethod": "PATCH",
      "httpParams": "{\"agents\":[{\"id\": ${account.accountID}}]}",
      "httpHeaders": {
        "Authorization": "${access_token}"
      },
      "httpContentType": "application/json",
      "successResponses": {
        "statusCode": [
          200,
          201,
          204
        ]
      }
    }
  ]
}


RemoveAccessJSON

{
  "call": [
    {
      "name": "groups",
      "connection": "acctAuth",
      "url": "https://localdomain.freshdesk.com/api/v2/admin/groups/${entitlementValue.entitlementID}/agents",
      "httpMethod": "PATCH",
      "httpParams": "{\"agents\":[{\"id\": ${account.accountID},\"deleted\": true}]}",
      "httpHeaders": {
        "Authorization": "${access_token}"
      },
      "httpContentType": "application/json",
      "successResponses": {
        "statusCode": [
          200,
          201,
          204
        ]
      }
    }
  ]
}

RemoveAccountJSON

{
  "call": [
    {
      "name": "call1",
      "connection": "acctAuth",
      "url": "https://localdomain.freshdesk.com/api/v2/agents/${account.accountID}",
      "httpMethod": "DELETE",
      "httpHeaders": {
        "Authorization": "${access_token}"
      },
      "httpContentType": "application/json",
      "successResponses": {
        "statusCode": [
          200,
          201,
          204
        ]
      }
    }
  ]
}