Back to Developer Center

API v1 Reference

Activity Webhooks

Webhooks can be sent when activities are created, edited, or deleted. Below are examples of the following actions:

Create Activity

Sent when an activity is created.

{ 
   "eventTrigger":"createActivity",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "activity":{ 
         "createdDateTime":"2006-01-03T01:30:22.000+08:00",
         "createdBy":"Administrator",
         "lastModifiedDateTime":"2006-01-03T01:30:22.000+08:00",
         "lastModifiedBy":"Administrator",
         "activityId":42,
         "subject":"Application Package",
         "note":"",
         "startDateTime":"2006-01-02T11:00:00.000-05:00",
         "clientId":97140,
         "systemUserId":97297,
         "activityStatus":{ 
            "id":"4",
            "name":"Completed"
         },
         "activityPriority":"NORMAL"
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Edit Activity

Sent when an activity is updated.

{ 
   "eventTrigger":"editActivity",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "activity":{ 
         "createdDateTime":"2006-01-03T01:30:22.000+08:00",
         "createdBy":"Administrator",
         "lastModifiedDateTime":"2006-01-03T01:30:22.000+08:00",
         "lastModifiedBy":"Administrator",
         "activityId":42,
         "subject":"Application Package",
         "note":"",
         "startDateTime":"2006-01-02T11:00:00.000-05:00",
         "clientId":97140,
         "systemUserId":97297,
         "activityStatus":{ 
            "id":"4",
            "name":"Completed"
         },
         "activityPriority":"NORMAL"
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Delete Activity

Sent when an activity is deleted.

{ 
   "eventTrigger":"deleteActivity",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "activity":{ 
         "activityId":3542,
         "deletedDateTime":"2013-01-24T03:42:59.000-06:00",
         "deletedBy":"Administrator "
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}