Skip to content

Endpoint: /Subscription/SubscribeToBillingEvent ​

This endpoint can be used by the consumer to subscribe to a webhook that will notify them of new billing events, or GEHRIMED signed encounters for patients that belong to customers for whom the consumer has subscribed.

Note: The x-scope must be provided in the header along with the OAuth token.

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
    }
}

Last updated:

Access to this API requires prior authorization.