Documentation

Request Payload

Payload of the request sent from HelpSpace to your App

{
    "ticket": {
        "id": 37,
        "subject": "Need help with your application",
        "tags": [
            "Help Request"
        ]
    },
    "from_contact": {
        "id": 30,
        "name": "John Doe",
        "value": "john.doe@test.com",
        "type": "email",
        "organization": null,
        'user' => [
            'id' => 2,
            "name": "John Doe",
            'contacts' => [
               [
                 "id" => 30
                 "value" => "john.doe@test.com"
                 "type" => "email"
               ],
               [
                 "id" => 35
                 "value" => "addtional.contact.email@test.com"
                 "type" => "email"
               ]
            ]
        ]
    },
    "team": {
        "id": 1,
        "name": "Support"
    },
    "assigned_agent": {
        "id": 2,
        "name": "Peter Griffin",
        "email": "peter.griffin@test.com",
        "roles": [
            "agent"
        ]
    },
    "viewing_agent": {
        "id": 4,
        "name": "Jane",
        "email": "jane.doe@test.com",
        "roles": [
            "admin"
        ]
    },
    "channel": {
        "id": 1,
        "name": "Support",
        "value": "support@yourdomain.com",
        "type": "email"
    }
}