Appearance
Endpoint: /Subscription/SubscribeToPatientEvent
This endpoint will provide the consumer with a webhook that notifies them anytime a customer who they are subscribed to has a new patient update in GEHRIMED.
Note: The x-scope must be provided in the header along with the OAuth token.
Request: JSON
{
"CallbackUrl": string
}| Field | Data Type | Required | Comments |
|---|---|---|---|
| CallbackUrl | String | Required | The URL to recieve the webhook. |
Response: JSON
{
"Metadata": {
"ApiSender": string,
"ApiConsumer": string,
"MessageDateTime": DateTime
},
"Data": {
"CallbackUrl": string,
"Success": bool,
"Message": string
}
}When the event occurs, the following notification will be sent out to the endpoint specified in the subscription. The x-scope will be provided in the header.
Event: JSON
{
"EventID": int,
"EventType": string,
"GroupID": int
}