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 survey
- processing - the user has completed the session and it is under review
- approved - the user has been issued a Letter-of-Medical-Necessity
- rejected - 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.
user_id: (Optional) - the user_id provided in the qualification session redirect URL param
- This field will be null if user_id wasn’t provided in the URL for creation.
source: (Optional) - the source provided in the qualification session redirect URL param
- This field will be null if source wasn’t provided in the URL for creation.

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

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 survey - `processing` - the user has completed the session and it is under review - `approved` - the user has been issued a Letter-of-Medical-Necessity - `rejected` - 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`. - `user_id`: **(Optional)** - the `user_id` provided in the qualification session redirect URL param - This field will be `null` if `user_id` wasn't provided in the URL for creation. - `source`: **(Optional)** - the `source` provided in the qualification session redirect URL param - This field will be `null` if `source` wasn't provided in the URL for creation. ## 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 payload of this webhook request is an object.

qualification_session_idstringRequired

The qualification_session_id returned by Truemed to the partner in create_qualification_session.

statusstringRequired

The status of the qualification_session.

emailstring or nullOptional

The email address of the consumer who completed the qualification session.

expires_atstring or nullOptional

An optional datetime at which the Letter-of-Medical-Necessity expires.

sourcestring or nullOptional

An optional source, if provided in the redirect.

user_idstring or nullOptional

An optional user_id, if provided in the redirect.

Response

204

Webhook received successfully (HTTP 204 No Content)

400

Invalid payload or authentication failure

500

Server error processing webhook