CRM WebHook

Setup Requirements

Provide a Webhook Listener URL
Ensure your listener accepts POST requests with JSON payloads
Secure your endpoint with HTTPS and token validation

Integration Details

To enable MyRegistry CRM integration with Webhook, partners must: Set Up a WebHook Listener

Field	Value
Format	JSON payload (POST)
Delivery	Real-time (near instant)
Retries	Failed deliveries are retried automatically
Topic(s)	Registry.Signup Registry.Update`

Message Structure

For Signup's (http body/json), each event contains two parts:

Metadata: information about the event (ID, timestamp, type, version)

Name	Type	Description
eventId	String	Identification of the Event (Internal Usage)
eventTime	DateTime	Event Date and Time (UTC)
topic	String	Type of Messages: “Registry.Signup” - A registry signed up to a merchant page “Registry.Update” - A registry complete the signup or updates the registry
dataVersion	String	Data version of the message
payLoad	RegistryData	Registry Data for the Signup in JSON format

Payload: detailed _registry data _and address data for the signup

Registry Data

Name	Type	Description
userId	Integer	User Identification (MyRegistry Internal ID)
registryId	Integer	Registry Identification (MyRegistry Internal ID)
firstName	String	Registrant First Name
lastName	String	Registrant Last Name
firstName2	String	Co-Registrant First Name
lastName2	String	Co-Registrant Last Name
registryTitle	String	Registry Title
email	String	Email address
registryType	Integer	The registrant's registry type - Wedding - Baby - Gift List - Organization
wishListType	String	Sub-Type of Gift List
eventDate	DateTime	Event Date (UTC)
signupDate	DateTime	Signup Date (UTC)
phone	String	Phone Number
mainAddress	AddressData	Main Address
shippingAddress	AddressData	Shipping Address
storeId	String	Partner’s StoreId associated with the Registry at Signup. Only present if signup happened on a Kiosk
signupCultureCode	String	Language code at signup (ISO-639 + ISO-3166)
registryUrl	String	URL link to registry
merchantRegistryUrl	String	Merchant URL link to registry
userWebsites	WebsiteData	List of websites with relation type: - SignupOrigin - SignupRelated - AssociatedPartner

Address Data

Name	Type	Description
street1	String	Address Street
street2	String	Address Street 2
city	String	Address City
state	String	Address State
zipCode	String	Address ZipCode
countryCode	String	Address Country code (ISO 3166-1 alpha-2 code)

Example Payload

Below is a sample Registry.Signup event delivered to webhook endpoint:

{
	"payLoad": {
    	"userId": 12639,
    	"registryId": 12621,
    	"firstName": "Test",
    	"lastName": "Subject",
    	"firstName2": "Second",
    	"lastName2": "Name",
    	"registryTitle": null,
    	"email": "[email protected]",
    	"registryType": 1,
    	"wishListType": "Housewarming",
    	"eventDate": "2024-10-31T04:00:00Z",
    	"signupDate": "2024-10-23T21:01:17.42Z",
    	"phone": "(202) 222-1234",
    	"mainAddress": {
        	"street1": "",
        	"street2": "",
        	"city": "Iselin",
        	"state": "NJ",
        	"zipCode": "",
        	"countryCode": "US"
    	},
    	"shippingAddress": {
        	"street1": "1234 Unicorn Parkway",
        	"street2": "",
        	"city": "The Bronx",
        	"state": "FL",
        	"zipCode": "12345",
        	"countryCode": "us"
    	},
    	"storeId": null,
	    "signupCultureCode": "fr-CA"
    "registryUrl": "https://www.myregistrystaging.com/wedding-registry/roman-test-the-bronx-ny/1619821",
    "merchantRegistryUrl": "https://canadiantire.myregistrystaging.com/wedding-registry/roman-test-the-bronx-ny/1619821",

      "userWebsites": [
        {
          "websiteId": 199103,
          "relationType": 1
        }
      ]
    	},
	"eventId": "EVT:5b2bc287-a6a7-4e32-8abf-4408e46a81fb",
	"eventTime": "2024-10-23T21:01:18.4974543Z",
	"topic": "Registry.Signup",
	"dataVersion": "1.0"
}

Testing Webhook

Use tools like Webhook.site or RequestBin to inspect real payloads
Confirm endpoint is returning a 2xx status code
Non-2xx responses trigger retries until successful