Skip to content

Endpoint: /Subscription/SubscribeToCustomerEvent ​

This endpoint will provide the consumer with a webhook that notifies them anytime a GEHRIMED customer gets the PatientDataApi enabled.

Note: This request doesn't use an x-scope as it is the way to obtain a customer's x-scope.

Note: This event type is currently inoperative.

Request: JSON

{
    "CallbackUrl": string
}
FieldData TypeRequiredComments
CallbackUrlStringRequiredThe 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.

Event: JSON

{
    "EventID": int,
    "EventType": string,
    "GroupID": int
}

Last updated:

Access to this API requires prior authorization.