Qualification Session Complete Webhook
The partner is required to implement an endpoint that Truemed requests to inform the partner
of the qualification_session status.
The qualification_session_complete webhook will only be called once for each qualification
session, on status change to approved, or rejected.
Authentication: Partners should verify the request comes from Truemed by checking that
the API key is present in the x-truemed-api-key HTTP header.
Request Notes
status- the status of the qualification session, an enum with one of the following values:pending- the user hasn’t has not completed the surveyprocessing- the user has completed the session and it is under reviewapproved- the user has been issued a Letter-of-Medical-Necessityrejected- the user is ineligible to receive a Letter-of-Medical-Necessity
expires_at: (Optional) - the datetime at which the Letter-of-Medical-Necessity expires- If the Letter-of-Medical-Necessity hasn’t been issued, this field will be
null.
- If the Letter-of-Medical-Necessity hasn’t been issued, this field will be
user_id: (Optional) - theuser_idprovided in the qualification session redirect URL param- This field will be
nullifuser_idwasn’t provided in the URL for creation.
- This field will be
source: (Optional) - thesourceprovided in the qualification session redirect URL param- This field will be
nullifsourcewasn’t provided in the URL for creation.
- This field will be
Response Notes
Success Case
HTTP Status: 204
The partner does not need to include any content in the body.
Failure Case
Truemed will retry the requests to your backend with backoff for up to 7 days
Payload
The qualification_session_id returned by Truemed when the qualification session was created via create_qualification_session.
The status of the qualification_session.
An optional datetime at which the Letter-of-Medical-Necessity expires (inclusive, UTC).
An optional user_id, if provided in the redirect.
Response
Webhook received successfully (HTTP 204 No Content)