Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Activity Webhook REST API Interface defines the REST API interface which customers will need to implement if they would like to consume and process ServiceMobility webhooks via their own systems.

By implementing an API which matches the Activity Webhook REST API Interface, customers can receive real-time updates regarding Activity records within ServiceMobility.

Note

Activity Webhook payload will contain one Activity Export Notification Object.



Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Activity Export Notification

POST <REST Endpoint URI>/Activities/

Include Page
_Default HTTP Headers for Interfaces
_Default HTTP Headers for Interfaces


API SpecificsSpecifics 


Panel
borderColor#D3D3D3

Activity Export Notification

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST <REST Endpoint URI>/Activities/

HTTP Request Body

The HTTP request body will contain a valid Webhook Request Object. Within the data property of the Webhook Request Object will be a valid Activity Export API Object.

Include Page
Webhook Request Object
Webhook Request Object

Activity Export Notification Object

Code Block
languagejs
firstline1
titleJSON Format
linenumberstrue
collapsetrue
{
    "rowver" : "",
    "rows" : [
        {
            "rowver" : "",
            "Activity" : {
               //  Activity JSON object properties
           }
        }
    ]
}

HTTP Response

Response Codes

HTTP CodeDescription
200OK. The Activity request was received successfully.
401Invalid Logon.
500Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause.

On success, an HTTP response code of 200 must be returned.