{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-api-explorer/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Notification events","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"notification-events","__idx":0},"children":["Notification events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whenever a status change occurs for a referral, Tyro Connect notifies you via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of referral events are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Referral Event"},"children":["Referral Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REFERRAL_STATUS_UPDATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The status of the referral has been updated"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sample-event","__idx":1},"children":["Sample Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"REFERRAL_STATUS_UPDATED\",\n  \"data\": {\n    \"id\": \"5491ec4a-3f46-4b4d-9bc0-23f2260f41c9\",\n    \"status\": \"REFERRAL_RECEIVED\",\n    \"uri\": \"https://api.tyro.com/connect/referrals/5491ec4a-3f46-4b4d-9bc0-23f2260f41c9\",\n    \"resource\": \"referrals\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Registering Webhooks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For information on how to register for webhooks and how to interpret the webhook message. Documentation can be found here: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/getting-started/notification-events/webhooks"},"children":["Webhooks"]}]}]}]},"headings":[{"value":"Notification events","id":"notification-events","depth":1},{"value":"Sample Event","id":"sample-event","depth":2}],"frontmatter":{"seo":{"title":"Notification events"}},"lastModified":"2026-09-02T06:39:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-explorer/referrals/1.0/notification-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}