For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • API Reference
      • GETList Catalog Items
      • POSTTruemed Checkout Method
      • POSTCreate Catalog Item
      • POSTUpdate Catalog Item
      • POSTGet Catalog Item Details
      • POSTItem Eligibility Updated Webhook
LogoLogo
API ReferenceProduct Catalog

Item Eligibility Updated Webhook

Payload
1{
2  "data": {
3    "object": {
4      "created_at": "2024-01-15T09:30:00Z",
5      "name": "string",
6      "sku": "string"
7    }
8  },
9  "event_type": "string",
10  "timestamp": "string"
11}
The partner can implement an endpoint that Truemed calls when the HSA/FSA eligibility status of an item changes. This webhook is triggered when: 1. An item's eligibility is updated (e.g., from `ineligible` to `eligible_with_lmn`) 2. An item is reviewed and its eligibility status is determined **Authentication**: Partners should verify the request comes from Truemed by checking that the `x-truemed-api-key` HTTP header matches their API key. ## Request Notes The webhook payload follows an envelope structure: - `event_type` - The event type identifier: `product_catalog.item.eligibility_updated` - `timestamp` - ISO-8601 timestamp of when the event occurred - `data.object` - The item details including: - `sku` - The SKU of the item - `name` - The name of the item - `eligibility` - The HSA/FSA eligibility status: - `eligible` - Item is default eligible for HSA/FSA - `eligible_with_lmn` - Item is eligible with a Letter of Medical Necessity - `ineligible` - Item is not eligible for HSA/FSA - `reviewed_at` - ISO-8601 timestamp of when the item was last reviewed ## 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
Was this page helpful?
Previous
Built with

The partner can implement an endpoint that Truemed calls when the HSA/FSA eligibility status of an item changes.

This webhook is triggered when:

  1. An item’s eligibility is updated (e.g., from ineligible to eligible_with_lmn)
  2. An item is reviewed and its eligibility status is determined

Authentication: Partners should verify the request comes from Truemed by checking that the x-truemed-api-key HTTP header matches their API key.

Request Notes

The webhook payload follows an envelope structure:

  • event_type - The event type identifier: product_catalog.item.eligibility_updated
  • timestamp - ISO-8601 timestamp of when the event occurred
  • data.object - The item details including:
    • sku - The SKU of the item
    • name - The name of the item
    • eligibility - The HSA/FSA eligibility status:
      • eligible - Item is default eligible for HSA/FSA
      • eligible_with_lmn - Item is eligible with a Letter of Medical Necessity
      • ineligible - Item is not eligible for HSA/FSA
    • reviewed_at - ISO-8601 timestamp of when the item was last reviewed

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.
dataobjectRequired
The webhook payload data.
event_typestringRequired

The type of event that triggered this webhook (e.g., ‘product_catalog.item.eligibility_updated’).

timestampstringRequired

ISO-8601 timestamp of when the event occurred.

Response

204

Webhook received successfully (HTTP 204 No Content)

400
Invalid payload or authentication failure
500
Server error processing webhook