Product Catalog Item Eligibility Updated Webhook
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 `not_eligible` 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
- `not_eligible` - 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.
data
The webhook payload data.
event_type
The type of event that triggered this webhook (e.g., ‘product_catalog.item.eligibility_updated’).
timestamp
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