Integrating your Moneypenny Live Chat with an API

To setup your integration, you will need to enter your Moneypenny billing account email address in {YOUR USERNAME} and your Moneypenny billing account password in {YOUR PASSWORD}. If you do not have these, please get in touch on 0345 123 3700 or [email protected].

Authentication

Request

curl --location ' https://api.moneypenny.com/auth/token' \--header 'Content-Type: application/json' \--data-raw '{
    "username": "{YOUR USERNAME}",
    "password": "{YOUR PASSWORD}"
}'

Response

{
    "access_token": "{A TOKEN}",
    "expires_in": 86400,
    "token_type": "Bearer"
}

When you receive the token you will then need to pass the token in as a header on every request:

The token will expire every 24 hours so you will need to call the above endpoint to get a new token every 24 hours

Request

curl --location 'https://test-api.moneypenny.com/clientlivechat/V3/Log' \

--header 'Authorization: Bearer {YOUR TOKEN}' \

The above date parameters are optional; if they are not passed in then the API will return all messages since the last time the endpoint was called.

Response

Your responses should look like the sample chat below:

[
    {
        "chatTime": "2024-02-06T13:02:09.877",
        "name": "A Gentleman",
        "companyName": "",
        "email": "[email protected]",
        "phone": "0123456789",
        "pageURL": "https://a-gentleman.co.uk",
        "entryURL": "https://a-gentleman.co.uk",
        "transcript": [
            "1: [Visitor] - [Visitor has started a chat. Pre-Chat Form Message: N/A]",
            "2: [Visitor] - Test"
        ],
        "variables": [
            {
                "name": "name",
                "value": "A Gentleman"
            }
        ],
        "tags": [],
        "utM_Source": "",
        "utM_Medium": "",
        "utM_Term": ""
    }
]

Need a hand? Give our team a call on 0345 123 3700 and we’ll talk you through the process.