Connect Freshdesk

How Freshdesk signs requests

Basic auth with your personal API key as the username. The password can be any characters, such as X.

Can you connect it today?

Yes. Add a basic-auth credential with your API key as the username and X as the password.

A sample mapping

Your application sends the first request below. The mapping turns it into the body of POST /api/v2/tickets, shown second.

{
    "subject": "Label not printing",
    "message": "The label for order 1042 comes out blank.",
    "from": "ops@shop.example"
}

{
    "subject": "Label not printing",
    "description": "The label for order 1042 comes out blank.",
    "email": "ops@shop.example",
    "priority": 1,
    "status": 2
}

The mapping

{
    "$schema": "https://schemas.echorelay.dev/transform/mapping/v1.json",
    "root": {
        "type": "object",
        "id": "root",
        "properties": {
            "subject": {
                "type": "field",
                "id": "subject",
                "path": "subject"
            },
            "description": {
                "type": "field",
                "id": "description",
                "path": "message"
            },
            "email": {
                "type": "field",
                "id": "email",
                "path": "from"
            },
            "priority": {
                "type": "constant",
                "id": "priority",
                "value": 1
            },
            "status": {
                "type": "constant",
                "id": "status",
                "value": 2
            }
        }
    }
}

The grammar, the answer mapping and the dry run are in the mapping docs.

What you bring

This is not a ready-made connector. You bring a sample request or Freshdesk’s OpenAPI document, you or your agent write the mapping, and we run the integration you define.