Back to Developer Center

API v1 Reference

Account Webhooks

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

Create Individual Account

Sent when an individual account is created.

{ 
   "eventTrigger":"createAccount",
   "eventTimestamp":"2013-01-24T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "individualAccount":{ 
         "createdDateTime":"2013-01-24T03:42:59.000-06:00",
         "createdBy":"Administrator ",
         "lastModifiedDateTime":"2013-01-24T03:42:59.000-06:00",
         "lastModifiedBy":"Administrator ",
         "accountId":3542,
         "primaryContact":{ 
            "contactId":5178,
            "firstName":"Jason",
            "lastName":"weng",
            "middleName":"mid",
            "prefix":"Mr.",
            "suffix":"test",
            "salutation":"brother",
            "preferredName":"kevin",
            "phone1":422794616,
            "phone1Type":"Home",
            "phone2":422794617,
            "phone2Type":"Work",
            "phone3":422794618,
            "phone3Type":"Mobile",
            "fax":422794620,
            "dob":"1988-10-16-05:00",
            "gender":{ 
               "code":"M",
               "name":"Male"
            },
            "email1":"kl@z2systems.com",
            "email2":"email2@z2systems.com",
            "email3":"email3@z2systems.com",
            "deceased":false,
            "addresses":{ 
               "address":[ 
                  { 
                     "addressId":3436,
                     "isPrimaryAddress":true,
                     "isShippingAddress":false,
                     "addressType":{ 
                        "id":1,
                        "name":"Home"
                     },
                     "addressLine1":"street1",
                     "city":"city",
                     "state":{ 
                        "code":"AL",
                        "name":"ALABAMA"
                     },
                     "county":"county",
                     "country":{ 
                        "id":2,
                        "name":"Canada"
                     },
                     "zipCode":111,
                     "zipCodeSuffix":222,
                     "startDate":"2012-01-01-06:00",
                     "endDate":"2013-01-01-06:00"
                  },
                  { 
                     "addressId":3437,
                     "isPrimaryAddress":false,
                     "addressType":{ 
                        "id":1,
                        "name":"Home"
                     },
                     "addressLine1":"aaa",
                     "addressLine2":"bbb",
                     "addressLine3":"ccc",
                     "addressLine4":"ddd",
                     "city":"city",
                     "state":{ 
                        "code":"AL",
                        "name":"ALABAMA"
                     },
                     "county":"county",
                     "country":{ 
                        "id":1,
                        "name":"United States"
                     },
                     "zipCode":39111,
                     "zipCodeSuffix":1355,
                     "startDate":"1990-03-16-06:00",
                     "endDate":"1990-03-17-06:00"
                  }
               ]
            },
            "department":"dep",
            "title":"SoftwareEngineer"
         },
         "noSolicitation":false,
         "url":"www.z2systems.com",
         "login":{ 
            "username":"admin123456"
         },
         "customFieldDataList":{ 
            "customFieldData":{ 
               "fieldId":73,
               "fieldOptionId":94
            }
         },
         "source":{ 
            "id":43,
            "name":"J. Starr"
         },
         "individualTypes":{ 
            "individualType":{ 
               "id":1,
               "name":"Organization"
            }
         }
         "consentInformation": {
           "emailConsentStatus": "NOT_ASKED",
           "phoneConsentStatus": "GIVEN",
           "mailConsentStatus": "NOT_ASKED",
           "smsConsentStatus": "NOT_ASKED",
           "dataSharingConsentStatus": "NOT_ASKED"
         }
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Create Organization Account

Sent when an organization account is created.

{ 
   "event":"createAccount",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "organizationAccount":{ 
         "createdDateTime":"2013-01-24T03:55:38.000-06:00",
         "createdBy":"Administrator ",
         "lastModifiedDateTime":"2013-01-24T03:55:38.000-06:00",
         "lastModifiedBy":"Administrator ",
         "accountId":3543,
         "primaryContact":{ 
            "contactId":5180,
            "firstName":"kevin",
            "lastName":"lee",
            "middleName":"mid",
            "prefix":"Mr.",
            "suffix":"test",
            "salutation":"brother",
            "preferredName":"kevin",
            "phone1":422794616,
            "phone1Type":"Home",
            "phone2":422794617,
            "phone2Type":"Work",
            "phone3":422794618,
            "phone3Type":"Mobile",
            "fax":422794620,
            "dob":"1988-10-16-05:00",
            "gender":{ 
               "code":"M",
               "name":"Male"
            },
            "deceased":false,
            "addresses":{ 
               "address":{ 
                  "addressId":3438,
                  "isPrimaryAddress":true,
                  "isShippingAddress":false,
                  "addressType":{ 
                     "id":1,
                     "name":"Home"
                  },
                  "addressLine1":"street1",
                  "city":"city",
                  "state":{ 
                     "code":"AL",
                     "name":"ALABAMA"
                  },
                  "county":"county",
                  "country":{ 
                     "id":2,
                     "name":"Canada"
                  },
                  "zipCode":111,
                  "zipCodeSuffix":222,
                  "startDate":"2012-01-01-06:00",
                  "endDate":"2013-01-01-06:00"
               }
            },
            "department":"dep",
            "title":"SoftwareEngineer"
         },
         "noSolicitation":false,
         "url":"www.z2systems.com",
         "customFieldDataList":{ 
            "customFieldData":{ 
               "fieldId":73,
               "fieldOptionId":94
            }
         },
         "source":{ 
            "id":43,
            "name":"J. Starr"
         },
         "organizationName":"kliOrganizationName",
         "organizationTypes":{ 
            "organizationType":{ 
               "id":1,
               "name":"Church"
            }
         }
         "consentInformation": {
           "emailConsentStatus": "NOT_ASKED",
           "phoneConsentStatus": "GIVEN",
           "mailConsentStatus": "NOT_ASKED",
           "smsConsentStatus": "NOT_ASKED",
           "dataSharingConsentStatus": "NOT_ASKED"
         }
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Edit Individual Account

Sent when an individual account is updated.

{ 
   "eventTrigger":"editAccount",
   "eventTimestamp":"2013-01-24T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "individualAccount":{ 
         "createdDateTime":"2013-01-24T03:42:59.000-06:00",
         "createdBy":"Administrator ",
         "lastModifiedDateTime":"2013-01-24T03:42:59.000-06:00",
         "lastModifiedBy":"Administrator ",
         "accountId":3542,
         "primaryContact":{ 
            "contactId":5178,
            "firstName":"Jason",
            "lastName":"weng",
            "middleName":"mid",
            "prefix":"Mr.",
            "suffix":"test",
            "salutation":"brother",
            "preferredName":"kevin",
            "phone1":422794616,
            "phone1Type":"Home",
            "phone2":422794617,
            "phone2Type":"Work",
            "phone3":422794618,
            "phone3Type":"Mobile",
            "fax":422794620,
            "dob":"1988-10-16-05:00",
            "gender":{ 
               "code":"M",
               "name":"Male"
            },
            "email1":"kl@z2systems.com",
            "email2":"email2@z2systems.com",
            "email3":"email3@z2systems.com",
            "deceased":false,
            "addresses":{ 
               "address":[ 
                  { 
                     "addressId":3436,
                     "isPrimaryAddress":true,
                     "isShippingAddress":false,
                     "addressType":{ 
                        "id":1,
                        "name":"Home"
                     },
                     "addressLine1":"street1",
                     "city":"city",
                     "state":{ 
                        "code":"AL",
                        "name":"ALABAMA"
                     },
                     "county":"county",
                     "country":{ 
                        "id":2,
                        "name":"Canada"
                     },
                     "zipCode":111,
                     "zipCodeSuffix":222,
                     "startDate":"2012-01-01-06:00",
                     "endDate":"2013-01-01-06:00"
                  },
                  { 
                     "addressId":3437,
                     "isPrimaryAddress":false,
                     "addressType":{ 
                        "id":1,
                        "name":"Home"
                     },
                     "addressLine1":"aaa",
                     "addressLine2":"bbb",
                     "addressLine3":"ccc",
                     "addressLine4":"ddd",
                     "city":"city",
                     "state":{ 
                        "code":"AL",
                        "name":"ALABAMA"
                     },
                     "county":"county",
                     "country":{ 
                        "id":1,
                        "name":"United States"
                     },
                     "zipCode":39111,
                     "zipCodeSuffix":1355,
                     "startDate":"1990-03-16-06:00",
                     "endDate":"1990-03-17-06:00"
                  }
               ]
            },
            "department":"dep",
            "title":"SoftwareEngineer"
         },
         "noSolicitation":false,
         "url":"www.z2systems.com",
         "login":{ 
            "username":"admin123456"
         },
         "customFieldDataList":{ 
            "customFieldData":{ 
               "fieldId":73,
               "fieldOptionId":94
            }
         },
         "source":{ 
            "id":43,
            "name":"J. Starr"
         },
         "individualTypes":{ 
            "individualType":{ 
               "id":1,
               "name":"Organization"
            }
         }
         "consentInformation": {
           "emailConsentStatus": "NOT_ASKED",
           "phoneConsentStatus": "GIVEN",
           "mailConsentStatus": "NOT_ASKED",
           "smsConsentStatus": "NOT_ASKED",
           "dataSharingConsentStatus": "NOT_ASKED"
         }
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Edit Organization Account

Sent when an organization account is updated.

{ 
   "event":"editAccount",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "organizationAccount":{ 
         "createdDateTime":"2013-01-24T03:55:38.000-06:00",
         "createdBy":"Administrator ",
         "lastModifiedDateTime":"2013-01-24T03:55:38.000-06:00",
         "lastModifiedBy":"Administrator ",
         "accountId":3543,
         "primaryContact":{ 
            "contactId":5180,
            "firstName":"kevin",
            "lastName":"lee",
            "middleName":"mid",
            "prefix":"Mr.",
            "suffix":"test",
            "salutation":"brother",
            "preferredName":"kevin",
            "phone1":422794616,
            "phone1Type":"Home",
            "phone2":422794617,
            "phone2Type":"Work",
            "phone3":422794618,
            "phone3Type":"Mobile",
            "fax":422794620,
            "dob":"1988-10-16-05:00",
            "gender":{ 
               "code":"M",
               "name":"Male"
            },
            "deceased":false,
            "addresses":{ 
               "address":{ 
                  "addressId":3438,
                  "isPrimaryAddress":true,
                  "isShippingAddress":false,
                  "addressType":{ 
                     "id":1,
                     "name":"Home"
                  },
                  "addressLine1":"street1",
                  "city":"city",
                  "state":{ 
                     "code":"AL",
                     "name":"ALABAMA"
                  },
                  "county":"county",
                  "country":{ 
                     "id":2,
                     "name":"Canada"
                  },
                  "zipCode":111,
                  "zipCodeSuffix":222,
                  "startDate":"2012-01-01-06:00",
                  "endDate":"2013-01-01-06:00"
               }
            },
            "department":"dep",
            "title":"SoftwareEngineer"
         },
         "noSolicitation":false,
         "url":"www.z2systems.com",
         "customFieldDataList":{ 
            "customFieldData":{ 
               "fieldId":73,
               "fieldOptionId":94
            }
         },
         "source":{ 
            "id":43,
            "name":"J. Starr"
         },
         "organizationName":"kliOrganizationName",
         "organizationTypes":{ 
            "organizationType":{ 
               "id":1,
               "name":"Church"
            }
         }
         "consentInformation": {
           "emailConsentStatus": "NOT_ASKED",
           "phoneConsentStatus": "GIVEN",
           "mailConsentStatus": "NOT_ASKED",
           "smsConsentStatus": "NOT_ASKED",
           "dataSharingConsentStatus": "NOT_ASKED"
         }
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Delete Account

Sent when an account is deleted.

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