External Events¶

External events allows Sharecare's platform to react on change.

Prerequisites

Before using Sharecare API's please read the API Integration Guide

Submitting External Events¶

Submit events to Sharecare's platform that were generated outside of Sharecare's domain.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace 'accountReference' with the target user id and '5nLpWr' with your API key

Request

curl -L -X POST 'https://gateway.uat.sharecare.com/events' \
-H 'X-API-Key: 5nLpWr' \
-H 'Content-Type: application/json' \
-H 'X-TXN-ID: abc-123-xyz' \
-d '[
    {
        "account": {
            "type": "accountId",
            "reference": "1a0f14c5-d82c-4788-aa7f-66c82b5f67c5"
        },
        "type": "INCENTIVE",
        "name": "clearcost-provider-search",
        "value": "COMPLETED",
        "meta": {
            "sponsor": "ER_NIAGARA",
            "date": "2023-09-14T16:41:43+0000"
        }
    }
]'