Toggle menu

PostEvent

Request Parameters

PostEvent Request Schema
 

Note - Providing a GUID is required if you have previously reserved slots and wish to set them as part of the even payload. If you are simply posting a new event then you can let the API create this and use the response in any follow up requests to PerformEventAction etc.

Example Request:

{
    "debug": true,
    "event": {
        "endDate": null,
        "data": [{
            "childData": [],
            "datatypeId": "41810",
            "value": "Luke"
        }, {
            "childData": [],
            "datatypeId": "41811",
            "value": "Taylor"
        }, {
            "childData": [{
                "childData": [],
                "datatypeId": "41828",
                "value": "24"
            }, {
                "childData": [],
                "datatypeId": "41831",
                "value": "An abandoned microwave"
            }, {
                "childData": [],
                "datatypeId": "41829",
                "value": "1"
            }],
            "datatypeId": "41827",
            "value": "Microwave"
        }, {
            "childData": [],
            "datatypeId": "41813",
            "value": "luke.taylor@email.com"
        }, {
            "childData": [],
            "datatypeId": "41839",
            "value": "50.00"
        }],
        "eventObjects": [{
            "objectRef": {
                "type": "PointAddress",
                "value": [6599297],
                "key": "Id"
            },
            "objectDescription": "Bulky Address",
            "eventObjectType": "Source"
        }],
        "dueDate": null,
        "eventTypeId": "2306",
        "taskReservations": [],
        "serviceId": "584",
        "eventDate": null
    }
}

Response Parameters

PostEvent Response Schema
 

Example Response:

{
    "jsonrpc": "2.0",
    "id": 7,
    "result": {
        "response": {
            "eventGuid": "ebd672ce-f39c-4d63-894d-9a0e0fa5fcc5"
        },
        "success": true
    }
}

Last modified on February 05, 2021

Share this page

Facebook icon Twitter icon email icon

Print

print icon