API v1 Reference

Membership Webhooks

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

Create Membership

Sent when a membership is created.

{ "eventTrigger":"createMembership", "eventTimestamp":"2017-05-04T03:42:59.000-06:00", "organizationId":"test", "data":{ "membership":{ "membershipId":134, "accountId":123958, "membershipTerm":{ "termInfo":{ "id":505, "name":"320 individual group 1" }, "isParentTerm":true }, "source":{ "id":51, "name":"Your Custom Selection" }, "customFieldDataList":"", "membershipName":"320 individual group 1", "termDuration":"1YEAR", "fee":360, "transactionDate":"2013-02-17T00:00:00.000-06:00", "termStartDate":"2023-09-01-05:00", "termEndDate":"2024-08-31-05:00", "enrollmentType":"JOIN", "status":"Succeed", "transaction":{ "transactionId":55571, "transactionStatus":"Succeed", "payments":{ "payment":{ "paymentId":44075, "amount":360, "paymentStatus":"Succeed", "note":"for membership term 507", "tenderType":{ "id":4, "name":"Credit Card(Online)" }, "creditCardOnlinePayment":{ "cardNumber":"************9236", "expirationMonth":9, "expirationYear":15, "cardType":{ "code":"v", "name":"" }, "cardHolder":"Dark Smith", "billingAddressLine1":"14/349 Geoge Street", "city":"Chicago", "state":{ "code":"IL" }, "country":{ "id":1, "name":"United States" }, "zipCode":60009 } } } } } }, "customParameters":{ "customParameterA":"value", "customParameterB":"other value" } }

Edit Membership

Sent when a membership is updated.

{ "eventTrigger":"editMembership", "eventTimestamp":"2017-05-04T03:42:59.000-06:00", "organizationId":"test", "data":{ "membership":{ "membershipId":134, "accountId":123958, "membershipTerm":{ "termInfo":{ "id":505, "name":"320 individual group 1" }, "isParentTerm":true }, "source":{ "id":51, "name":"Your Custom Selection" }, "customFieldDataList":"", "membershipName":"320 individual group 1", "termDuration":"1YEAR", "fee":360, "transactionDate":"2013-02-17T00:00:00.000-06:00", "termStartDate":"2023-09-01-05:00", "termEndDate":"2024-08-31-05:00", "enrollmentType":"JOIN", "status":"Succeed", "transaction":{ "transactionId":55571, "transactionStatus":"Succeed", "payments":{ "payment":{ "paymentId":44075, "amount":360, "paymentStatus":"Succeed", "note":"for membership term 507", "tenderType":{ "id":4, "name":"Credit Card(Online)" }, "creditCardOnlinePayment":{ "cardNumber":"************9236", "expirationMonth":9, "expirationYear":15, "cardType":{ "code":"v", "name":"" }, "cardHolder":"Dark Smith", "billingAddressLine1":"14/349 Geoge Street", "city":"Chicago", "state":{ "code":"IL" }, "country":{ "id":1, "name":"United States" }, "zipCode":60009 } } } } } }, "customParameters":{ "customParameterA":"value", "customParameterB":"other value" } }

Delete Membership

Sent when a membership is deleted.

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