Web Hooks


With the web hook endpoints, you can subscribe and unsubscribe to events within your Referral Rock account. To subscribe and unsubscribe, call the endpoints respectively described here and here. the set of events supported is listed below. the sample included with each event is an example of the request body that will be sent with the post request to the endpoint specified.

Available events for Programs:
  • ProgramAdd
  • ProgramUpdate
    (*sent only on activation change)
  • ProgramDelete
Available events for Members:
  • MemberAdd
  • MemberUpdate
  • MemberDelete
Available events for Referrals:
  • ReferralAdd
  • ReferralUpdate
    (*sent on any change including status change)
  • ReferralDelete
  • ReferralStatusChange
Available events for Rewards:
  • RewardAdd
  • RewardUpdate
    (*sent on any change including reward issue)
  • RewardDelete
  • RewardIssue
Available events for Emails:
  • EmailUnsubscribed

Event Details

ProgramAdd, ProgramUpdate, ProgramDelete

Sample:
{
    "Id": "00000000-0000-0000-0000-000000000000",
    "IsActive": true,
    "IsDefault": true,
    "Name": "New Referrals Program",
    "Type": "Web",
    "Title": "New Referrals Program",
    "MemberOffer": "Gift Card",
    "ReferralOffer": "Another Gift Card",
    "DirectUrl": "http://www.example.com",
    "WidgetUrl": "http://widget.example.com",
    "LoginUrl": "http://login.example.com",
    "RegistrationViews": 0,
    "MembersRegistered": 0,
    "MemberViews": 0,
    "ReferralViews": 0,
    "ReferralsCreated": 0,
    "ReferralsApproved": 0,
    "MembersActive": 0,
    "MembersDisabled": 0,
    "ReferralsPending": 0,
    "ReferralsQualified": 0,
    "ReferralsDenied": 0,
    "ReferralsApprovedAmount": 0.0,
    "RewardsCreated": 0,
    "RewardsPending": 0,
    "RewardsIssued": 0,
    "RewardsIssuedAmount": 0.0
}
                

MemberAdd, MemberUpdate, MemberRemove

Sample:
        {
            "Id": "00000000-0000-0000-0000-000000000002",
            "displayName": "Test Inc (example@site.com)",
            "firstName": "firstName",
            "lastName": "lastName",
            "email": "example@site.com",
            "phone": "",
            "externalIdentifier": "",
            "dateOfBirth": null,
            "addressLine1": "",
            "addressLine2": "",
            "city": "",
            "countrySubdivision": "",
            "country": "",
            "postalCode": "",
            "disabledFlag": false,
            "customOverrideURL": "",
            "payoutInfo": null,
            "customOption1Name": "",
            "customOption1Value": "",
            "customText1Name": "",
            "customText1Value": "",
            "customText2Name": "",
            "customText2Value": "",
            "programId": "00000000-0000-0000-0000-000000000002",
            "programTitle": "Customer Referral Program",
            "programName": "myprogram",
            "referralUrl": "https://example/l/E14D26F4/",
            "referralCode": "E14D26F4",
            "memberUrl": ""https://example/l/E14D26F4/",
            "emailShares": 0,
            "socialShares": 0,
            "views": 0,
            "referrals": 0,
            "lastShare": null,
            "referralsApproved": 0,
            "referralsQualified": 0,
            "referralsPending": 0,
            "referralsApprovedAmount": 0,
            "rewardsPendingAmount": 0,
            "rewardsIssuedAmount": 0,
            "rewardAmountTotal": 0,
            "rewards": 0,
            "createDt": "2018-04-04T16:58:06.947Z"
        }
                

ReferralAdd, ReferralUpdate, ReferralStatusChange, ReferralDelete

Sample:
{
    "Id": "00000000-0000-0000-0000-000000000002",
    "DisplayName" : "Jane Doe (Jane@example.com)",
    "FullName": "Jane Doe",
    "FirstName": "Jane",
    "LastName": "Doe",
    "CompanyName": "Taco Inc.",
    "Email": "Jane@example.com",
    "ExternalId": "00000000-0000-0000-0000-000000000000",
    "PhoneNumber": "888-555-1212",
    "Amount": 0,
    "PreferredContact": "Email Me",
    "CreatedDate": "2016-04-10T18:46:21.3597347Z",
    "ProgramId": "00000000-0000-0000-0000-000000000000",
    "ProgramName": "New Referrals Program",
    "ProgramTitle": "New Referrals Program",
    "MemberId": "00000000-0000-0000-0000-0000000000001",
    "MemberName": "Jon Doe",
    "MemberEmail": "Jon@example.com",
    "MemberReferralCode": "ABC12345",
    "ApprovedDate": "2016-04-10T18:46:21.3597347Z",
    "QualifiedDate": "2016-04-10T18:46:21.3597347Z", 
    "Status": "Pending",                   
    "UpdateDate": "2016-04-10T18:46:21.3597347Z",
    "Note": "Note",
    "PublicNote": "Public Note",
    "AmountFormatted": "$0.00",
    "CustomOption1Name": "",
    "CustomOption2Name": "",
    "CustomText1Name": "",
    "CustomText2Name": "",
    "CustomText3Name": "",
    "CustomOption1Value": "",
    "CustomOption2Value": "",
    "CustomText1Value": "",
    "CustomText2Value": "",
    "CustomText3Value": "",
    "ConversionNote": "",
    "ConversionIPAddress": "" 
}
                

RewardAdd, RewardUpdate, RewardIssue, RewardDelete

Sample:
{
    "Id": "00000000-0000-0000-0000-000000000000",
    "PayoutId": "00000000-0000-0000-0000-000000000000",
    "PayoutDescription": null,
    "ProgramId": "00000000-0000-0000-0000-000000000000",
    "ProgramName": null,
    "MemberId": null,
    "ReferralId": null,
    "Type": null,
    "RecipientId": null,
    "RecipientName": null,
    "RecipientEmailAddress": null,
    "Status": null,
    "Amount": 0.0,
    "CreateDate": "0001-01-01T00:00:00",
    "IssueDate": null,
    "EligibilityDate": "0001-01-01T00:00:00",
    "Description": null,
    "TransactionID": "00000000-0000-0000-0000-000000000000",
    "UpdateDate": "0001-01-01T00:00:00",
    "ReferralDisplayName": null
}
                

EmailUnsubscribed

Sample:
      {
            "Message": "Email added to unsubcribed list for all email types",
            "Email": "test123@google.com",
            "eventName": "EmailUnsubscribed"
        }