Events
The Webhook events that we currently support are listed below.
NOTE: We expect to add more events overtime, so while developing and maintaining your code, you should not assume that the list shown below is a final list.
| Webhook | Description |
|---|---|
| lynx.accountBalanceAlert | Sent when the FBO_CONTRIBUTION account balance falls below predefined limits |
| lynx.addressPrimaryUpdate | Sent when a member's primary address is updated. |
| lynx.cardStatusChanged | Sent when the status of member card changes (for e.g. from "Active" to "Frozen", etc.) |
| lynx.clientOrgCreated | Sent to when a child client org is created |
| lynx.clientOrgTransactionCreated | Sent when a transaction is created on any of the underlying client org accounts |
| lynx.enrollmentAwaitingDocuments | Sent when additional documentation for a member is required to complete the member product enrollment |
| lynx.enrollmentDenied | Sent when a member enrollment is denied after compliance review |
| lynx.enrollmentPendingReview | Sent when an enrollment is pending compliance review |
| lynx.memberTransactionCreated | Sent when a transaction is created on any of the underlying member accounts |
| lynx.memberAuthorizationCreated | Sent when a member authorization is created |
| lynx.claimCreated | Sent when a claim is created |
| lynx.claimUpdated | Sent when a claim is updated |
| lynx.clientOrgApplicationStatusChangeEvent | Sent when the status on a client org application is changed |
| lynx.commerceOrderAcknowledgement | Sent when a commerce order is acknowleged |
| lynx.commerceOrderShipment | Sent when a commerce order has shipped |
| lynx.commerceOrderDelivered | Sent when a commerce order is delivered |
| lynx.transactionReturned | Sent when a transaction is returned |
| lynx.phoneNumberPrimaryUpdate | Sent when the primary phone number hs been updated |
| lynx.relatedPersonAdded | Sent when a related person is added |
| lynx.relatedPersonUpdated | Sent when a related person is updated |
| lynx.relatedPersonDeleted | Sent when a related person is deleted |
Event Payload Formats
Please find below the sample JSONs for Lynx Webhook events.
lynx.accountBalanceAlert
{
"data": {
"eventType": "lynx.accountBalanceAlert",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC"
},
"member": {
"clientMemberId": "12556"
},
"clientOrgAccount": {
"clientOrgAccountId": "37d002e9-f44b-4039-ab5f-532ffc16a11c",
"accountNumber": "82345",
"balanceAmount": "2000.00",
"limitAmount": "2500.00"
},
"memberTransaction": {
"referenceIdentifier": "TRANSXXXX10000"
},
"memberProduct": {
"productName": "INCENTIVE"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.accountBalanceAlert"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
}
},
"required": ["clientMemberId"]
},
"clientOrgAccount": {
"type": "object",
"properties": {
"clientOrgAccountId": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"balanceAmount": {
"type": "number"
},
"limitAmount": {
"type": "number"
}
},
"required": ["clientOrgAccountId", "accountNumber", "balanceAmount", "limitAmount"]
},
"memberTransaction": {
"type": "object",
"properties": {
"referenceIdentifier": {
"type": "string"
}
},
"required": ["referenceIdentifier"]
},
"memberProduct": {
"type": "object",
"properties": {
"productName": {
"type": "string"
}
},
"required": ["productName"]
}
},
"required": ["eventType", "clientOrg", "member", "clientOrgAccount",
"memberTransaction", "memberProduct"]
}
},
"required": ["data"]
}lynx.addressPrimaryUpdate
{
"data": {
"eventType": "lynx.addressPrimaryUpdate",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "3f50436491",
"memberProducts": {
"productName": "Premium Checking Account"
}
},
"oldPrimaryAddress": {
"type": "RESIDENTIAL",
"typeDescription": "Home Address",
"name": "John Doe",
"attentionCareOf": "c/o Jane Smith",
"line3": "Building C",
"line4": "Floor 2",
"pobox": "PO Box 12345",
"county": "USA",
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "San Francisco",
"stateProvince": "CA",
"country": "USA",
"postalCode": "94107",
"postalCodeExtension": "1234",
"primaryIndicator": "true"
},
"newPrimaryAddress": {
"type": "RESIDENTIAL",
"typeDescription": "Home Address",
"name": "John Doe",
"attentionCareOf": "c/o Jane Smith",
"line3": "Building C",
"line4": "Floor 2",
"pobox": "PO Box 12345",
"county": "USA",
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "San Francisco",
"stateProvince": "CA",
"country": "USA",
"postalCode": "94107",
"postalCodeExtension": "1234",
"primaryIndicator": "true"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.addressPrimaryUpdate"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"memberProducts": {
"type": "object",
"properties": {
"productName": {
"type": "string"
}
},
"required": ["productName"]
}
},
"required": ["clientMemberId", "memberProducts"]
},
"oldPrimaryAddress": {
"$ref": "#/definitions/address"
},
"newPrimaryAddress": {
"$ref": "#/definitions/address"
}
},
"required": ["eventType", "clientOrg", "member", "oldPrimaryAddress",
"newPrimaryAddress"]
}
},
"required": ["data"],
"definitions": {
"address": {
"type": "object",
"properties": {
"type": {
"enum": ["RESIDENTIAL", "BUSINESS"]
},
"typeDescription": {
"type": "string"
},
"name": {
"type": "string"
},
"attentionCareOf": {
"type": "string"
},
"line3": {
"type": "string"
},
"line4": {
"type": "string"
},
"pobox": {
"type": "string"
},
"county": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"stateProvince": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"postalCodeExtension": {
"type": "string"
},
"primaryIndicator": {
"enum": ["true", "false"]
}
},
"required": [
"type",
"typeDescription",
"name",
"attentionCareOf",
"line3",
"line4",
"pobox",
"county",
"line1",
"line2",
"city",
"stateProvince",
"country",
"postalCode",
"postalCodeExtension",
"primaryIndicator"
]
}
}
}lynx.cardStatusChanged
{
"data": {
"eventType": "lynx.cardStatusChanged",
"member": {
"clientMemberId": "12345"
},
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"cardStatus": {
"cardStatus": "Lost",
"cardStatusReason": "Lost",
"statusDate": "2022-10-20",
"cardLastFour": "5678"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.cardStatusChanged"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
}
},
"required": ["clientMemberId"]
},
"cardStatus": {
"type": "object",
"properties": {
"cardStatus": {
"enum": [
"New",
"Replaced",
"Closed",
"Lost",
"Stolen",
"Frozen",
"Active",
"Inactive"
]
},
"cardStatusReason": {
"type": "string"
},
"statusDate": {
"type": "string",
"format": "date"
},
"cardLastFour": {
"type": "string",
"pattern": "^\\d{4}$"
}
},
"required": ["cardStatus", "cardStatusReason", "statusDate", "cardLastFour"]
}
},
"required": ["eventType", "clientOrg", "member", "cardStatus"]
}
},
"required": ["data"]
}lynx.clientOrgCreated
{
"data": {
"eventType": "lynx.clientOrgCreated",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"clientOrgChild": {
"clientOrgName": "Health_Plan_ABC_DivisionChild"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.clientOrgCreated"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"clientOrgChild": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
}
},
"required": ["eventType", "clientOrg", "clientOrgChild"]
}
},
"required": ["data"]
}lynx.clientOrgTransactionCreated
{
"data":{
"eventType":"lynx.clientOrgTransactionCreated",
"clientOrg":{
"clientOrgName":"Health_Plan_ABC_Division"
},
"clientOrgAccount":{
"id": "4dbdba69-4875-47c5-a663-04d9aee9ee91",
"accountQualifierType":"INCENTIVE_DISTRIBUTION"
},
"transaction": {
"status": "Settled",
"type": "MemberPurchase",
"category": "CARD",
"amount": "125.50",
"direction": "Debit",
"longMemo": "Purchase at ACME Store",
"shortMemo": "ACME Store",
"referenceIdentifier": "TRANS00002441780",
"addDatetime": "2025-06-27 15:59:22.782"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.clientOrgTransactionCreated"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"clientOrgAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"accountQualifierType": {
"type": "string"
}
},
"required": ["id", "accountQualifierType"]
},
"transaction": {
"type": "object",
"properties": {
"status": {
"enum": [
"Pending",
"Settled",
"Rejected",
"Sent"
]
},
"type": {
"enum": [
"MemberPurchase",
"BenefitDisbursement",
"OtherTransactionType"
]
},
"category": {
"enum": [
"ADJUSTMENT",
"CARD",
"CONTRIBUTION",
"DEPOSIT",
"DISBURSEMENT",
"DVH_SERVICE",
"REDEMPTION",
"RETURN",
"REIMBURSEMENT",
"TRANSFER",
"WITHDRAWL"
]
},
"amount": {
"type": "string",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"direction": {
"enum": [
"Debit",
"Credit"
]
},
"longMemo": {
"type": "string"
},
"shortMemo": {
"type": "string"
},
"referenceIdentifier": {
"type": "string"
},
"addDatetime": {
"type": "string",
"format": "date-time"
}
},
"required": ["status", "type", "category", "amount", "direction", "longMemo",
"shortMemo", "referenceIdentifier", "addDatetime"]
}
},
"required": ["eventType", "clientOrg", "clientOrgAccount", "transaction"]
}
},
"required": ["data"]
}
lynx.enrollmentAwaitingDocuments
{
"data": {
"eventType": "lynx.enrollmentAwaitingDocuments",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "12345",
"status": "NEW",
"statusReason": "null",
"statusDate": "2022-10-19",
"memberProducts": [
{
"productName": "HSA",
"status": "App_Awaiting_Documents",
"statusReason": "null",
"statusDate": "2022-10-19",
"documents": [
{
"documentId": "1",
"documentType": "AddressVerification",
"documentName": "Peter Parker",
"documentDescription": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
"documentStatus": "Required",
"documentStatusReason": "Required"
}
]
}
],
"tags": [
{
"tagName": "some name",
"tagValue": "someValue"
}
]
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.enrollmentAwaitingDocuments"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"status": {
"enum": [
"NEW",
"ACTIVE",
"INACTIVE",
"CANCELLED"
]
},
"statusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusDate": {
"type": "string",
"format": "date"
},
"memberProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productName": {
"type": "string"
},
"status": {
"enum": [
"Approved",
"Uploaded",
"Required"
]
},
"statusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusDate": {
"type": "string",
"format": "date"
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"type": "string"
},
"documentType": {
"enum": [
"IDCard",
"BirthCertificate",
"UtilityBill",
"BankStatement",
"LeaseAgreement",
"PayStub",
"AddressVerification",
"EmploymentHistory",
"TaxReturns"
]
},
"documentName": {
"type": "string"
},
"documentDescription": {
"type": "string"
},
"documentStatus": {
"enum": [
"Required",
"Pending",
"Completed",
"Rejected"
]
},
"documentStatusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": ["documentId", "documentType", "documentName",
"documentDescription", "documentStatus", "documentStatusReason"]
}
}
},
"required": ["productName", "status", "statusReason", "statusDate",
"documents"]
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagName": {
"type": "string"
},
"tagValue": {
"type": "string"
}
},
"required": ["tagName", "tagValue"]
}
}
},
"required": ["clientMemberId", "status", "statusReason", "statusDate",
"memberProducts", "tags"]
}
},
"required": ["eventType", "clientOrg", "member"]
}
},
"required": ["data"]
}lynx.enrollmentDenied
{
"data": {
"eventType": "lynx.enrollmentDenied",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "12345",
"status": "NEW",
"statusReason": "null",
"statusDate": "2022-10-19",
"memberProducts": [
{
"productName": "HSA",
"status": "App_Denied",
"statusReason": "null",
"statusDate": "2022-10-19"
}
],
"tags": [
{
"tagName": "some name",
"tagValue": "someValue"
}
]
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.enrollmentDenied"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"status": {
"enum": [
"NEW",
"ACTIVE",
"INACTIVE",
"CANCELLED"
]
},
"statusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusDate": {
"type": "string",
"format": "date"
},
"memberProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productName": {
"type": "string"
},
"status": {
"string": "App_Denied"
},
"statusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusDate": {
"type": "string",
"format": "date"
}
},
"required": ["productName", "status", "statusReason", "statusDate"]
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagName": {
"type": "string"
},
"tagValue": {
"type": "string"
}
},
"required": ["tagName", "tagValue"]
}
}
},
"required": ["clientMemberId", "status", "statusReason", "statusDate",
"memberProducts", "tags"]
}
},
"required": ["eventType", "clientOrg", "member"]
}
},
"required": ["data"]
}lynx.enrollmentPendingReview
{
"data": {
"eventType": "lynx.enrollmentPendingReview",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "12345",
"status": "NEW",
"statusReason": "null",
"statusDate": "2022-10-19",
"memberProducts": [
{
"productName": "HSA",
"status": "App_Pending_Review",
"statusReason": "null",
"statusDate": "2022-10-19"
}
],
"tags": [
{
"tagName": "some name",
"tagValue": "someValue"
}
]
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.enrollmentPendingReview"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"status": {
"enum": [
"NEW",
"ACTIVE",
"INACTIVE",
"CANCELLED"
]
},
"statusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusDate": {
"type": "string",
"format": "date"
},
"memberProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productName": {
"type": "string"
},
"status": {
"enum": [
"Enrolled",
"Not_Enrolled",
"App_Pending_Review",
"Waiting_for_Benefit",
"Benefit_Awaiting_Payment"
]
},
"statusReason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusDate": {
"type": "string",
"format": "date"
}
},
"required": ["productName", "status", "statusReason", "statusDate"]
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagName": {
"type": "string"
},
"tagValue": {
"type": "string"
}
},
"required": ["tagName", "tagValue"]
}
}
},
"required": ["clientMemberId", "status", "statusReason", "statusDate",
"memberProducts", "tags"]
}
},
"required": ["eventType", "clientOrg", "member"]
}
},
"required": ["data"]
}
lynx.memberTransactionCreated
{
"data": {
"eventType": "lynx.memberTransactionCreated",
"member": {
"clientMemberId": "12345"
},
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"transaction": {
"status": "Settled",
"category": "DEPOSIT",
"amount": "51.77",
"direction": "Debit",
"type": "EcommerceBuy",
"longMemo": "E-Commerce Order",
"shortMemo": "Ecommerce",
"transactionDate": "2024-11-13",
"referenceIdentifier": "TRANS000022521680",
"addDatetime": "2024-11-13 08:49:17.389",
"merchantName": "ACME Store",
"merchantCity": "San Francisco",
"merchantStateProvince": "CA",
"mcc": "BADCH",
"authorizationDatetime": "2024-11-13 08:49:10.290",
"settlementDatetime": "2024-11-13 09:04:27.066",
"cardPresentIndicator": false,
"partnerTransactionTypeDescription": "Adjustment"
},
"memberAccount": {
"id": "5bdc4c34-fda1-4f61-85cf-403eb42c7e5f",
"type": "CHECKING"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.memberTransactionCreated"
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
}
},
"required": ["clientMemberId"]
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"transaction": {
"type": "object",
"properties": {
"status": {
"enum": [
"Pending",
"Settled",
"Failed"
]
},
"category": {
"enum": [
"ADJUSTMENT",
"CARD",
"CONTRIBUTION",
"DEPOSIT",
"DISBURSEMENT",
"DVH_SERVICE",
"REDEMPTION",
"RETURN",
"WITHDRAWL"
]
},
"amount": {
"type": "string",
"pattern": "^\\d+(\\.\\d{2})?$"
},
"direction": {
"enum": [
"Debit",
"Credit"
]
},
"type": {
"type": "string"
},
"longMemo": {
"type": "string"
},
"shortMemo": {
"type": "string"
},
"transactionDate": {
"type": "string",
"format": "date"
},
"referenceIdentifier": {
"type": "string"
},
"addDatetime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"merchantName": {
"type": "string",
"nullable": true
},
"merchantCity": {
"type": "string",
"nullable": true
},
"merchantStateProvince": {
"type": "string",
"nullable": true
},
"mcc": {
"type": "string",
"nullable": true
},
"authorizationDatetime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"settlementDatetime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"cardPresentIndicator": {
"type": "boolean"
},
"partnerTransactionTypeDescription": {
"type": "string",
"nullable": true
}
},
"required": ["status", "category", "amount", "direction", "type", "longMemo",
"shortMemo", "transactionDate", "referenceIdentifier"]
},
"memberAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"CHECKING",
"SAVINGS",
"CREDIT_CARD"
]
}
},
"required": ["id", "type"]
}
},
"required": ["eventType", "member", "clientOrg", "transaction", "memberAccount"]
}
},
"required": ["data"]
}lynx.memberAuthorizationCreated
{
"data": {
"eventType": "lynx.memberAuthorizationCreated",
"createdAt": "2026-02-18T16:30:45.123Z",
"tags": [
{
"name": "source",
"value": "card_processor"
},
{
"name": "priority",
"value": "high"
}
],
"clientOrg": {
"name": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "3f50436491"
},
"memberCard": {
"cardLastFour": "9118",
"id": "5263218885395"
},
"memberAccount": {
"availableBalance": 379.00,
"id": "e008a16d-54a8-4eea-9480-116b21c164f7",
"type": "HSA"
},
"memberAuthorization": {
"mcc": 5912,
"amount": 42.75,
"authorizationDatetime": "2026-02-18T16:29:30.000Z",
"authorizationId": "4dbdd4694-4875-47d2-b663-04d9aee9ee30",
"category": "HEALTHCARE",
"clientTransactionIdentifier": "4dbdd4694-4875-47d2-b663-04d9aee9ee30",
"merchantName": "MTA VENDING MACHINES",
"status": "APPROVED",
"type": "PURCHASE",
"cardPresentIndicator": true,
"transactionTypeDescription": "Card Present Purchase"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "MemberAuthorizationCreatedEvent",
"description": "Event triggered when a member card authorization is created",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "MemberAuthorizationCreatedEventData containing authorization information",
"required": ["eventType", "createdAt", "clientOrg", "member", "memberCard", "memberAccount", "memberAuthorization"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["lynx.memberAuthorizationCreated"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrg": {
"type": "object",
"description": "Client organization information",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the client organization"
}
}
},
"member": {
"type": "object",
"description": "Member information",
"required": ["clientMemberId"],
"properties": {
"clientMemberId": {
"type": "string",
"description": "Unique client-side identifier for the member"
}
}
},
"memberCard": {
"type": "object",
"description": "Member card information",
"required": ["cardLastFour", "id"],
"properties": {
"cardLastFour": {
"type": "string",
"description": "Last four digits of the card number",
"pattern": "^[0-9]{4}$"
},
"id": {
"type": "string",
"description": "Card identifier"
}
}
},
"memberAccount": {
"type": "object",
"description": "Member account information",
"required": ["availableBalance", "id", "type"],
"properties": {
"availableBalance": {
"type": "number",
"description": "Available balance to spend for the account"
},
"id": {
"type": "string",
"description": "Account identifier",
"format": "uuid"
},
"type": {
"type": "string",
"description": "Type of account"
}
}
},
"memberAuthorization": {
"type": "object",
"description": "Authorization information",
"required": ["amount", "authorizationDatetime", "authorizationId", "merchantName", "status", "type"],
"properties": {
"mcc": {
"type": "integer",
"description": "Merchant Category Code"
},
"amount": {
"type": "number",
"description": "Authorization amount"
},
"authorizationDatetime": {
"type": "string",
"description": "Timestamp when the authorization occurred",
"format": "date-time"
},
"authorizationId": {
"type": "string",
"description": "Unique identifier for the authorization"
},
"category": {
"type": "string",
"description": "Category of the transaction"
},
"clientTransactionIdentifier": {
"type": "string",
"description": "Unique client-defined identifier for the transaction"
},
"merchantName": {
"type": "string",
"description": "Name of merchant accepting the transaction"
},
"status": {
"type": "string",
"description": "Status of the authorization",
"enum": ["APPROVED", "DECLINED", "PENDING"]
},
"type": {
"type": "string",
"description": "Type of authorization",
"enum": ["PURCHASE", "REFUND", "WITHDRAWAL", "PAYMENT"]
},
"cardPresentIndicator": {
"type": "boolean",
"description": "Indicates whether the card was physically present for the transaction"
},
"transactionTypeDescription": {
"type": "string",
"description": "Description of the transaction type"
}
}
}
}
}
}
}lynx.claimCreated
{
"data": {
"eventType": "claim.created",
"createdAt": "2026-02-18T10:30:45.123Z",
"tags": [
{
"name": "source",
"value": "member_portal"
},
{
"name": "priority",
"value": "high"
}
],
"clientOrg": {
"name": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "3f50436491"
},
"memberClaim": {
"claimNumber": "CLM-2026-00123",
"memberAccount": {
"id": "e008a16d-54a8-4eea-9480-116b21c164f7"
},
"memberBankAccount": {
"id": "4dbdba69-4875-47c5-a663-04d9aee9ee91"
},
"status": "PENDING",
"statusReason": "Awaiting review",
"claimAmount": 379.00,
"approvedAmount": 0.00,
"expenseDate": "2026-02-15",
"reimbursementType": "DIRECT_DEPOSIT",
"merchantType": "PHARMACY",
"merchantName": "City Pharmacy",
"addDatetime": "2026-02-18T10:30:00.000Z",
"category": "PRESCRIPTION"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "MemberClaimEvent",
"description": "Event for claim related events: claim.created and claim.updated",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "MemberClaimEventData containing claim information",
"required": ["eventType", "createdAt", "clientOrg", "member", "memberClaim"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["claim.created", "claim.updated"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrg": {
"type": "object",
"description": "Client organization information",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the client organization"
}
}
},
"member": {
"type": "object",
"description": "Member information",
"required": ["clientMemberId"],
"properties": {
"clientMemberId": {
"type": "string",
"description": "Unique client-side identifier for the member"
}
}
},
"memberClaim": {
"type": "object",
"description": "Claim information",
"required": ["claimNumber", "status"],
"properties": {
"claimNumber": {
"type": "string",
"description": "Unique identifier for the claim"
},
"memberAccount": {
"type": "object",
"description": "Member account information",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member account",
"format": "uuid"
}
}
},
"memberBankAccount": {
"type": "object",
"description": "Member bank account information",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member bank account",
"format": "uuid"
}
}
},
"status": {
"type": "string",
"description": "Status of the claim"
},
"statusReason": {
"type": "string",
"description": "Reason for the current status"
},
"claimAmount": {
"type": "number",
"description": "Amount claimed"
},
"approvedAmount": {
"type": "number",
"description": "Amount approved for reimbursement"
},
"expenseDate": {
"type": "string",
"description": "Date of the expense",
"format": "date"
},
"reimbursementType": {
"type": "string",
"description": "Type of reimbursement"
},
"merchantType": {
"type": "string",
"description": "Type of merchant"
},
"merchantName": {
"type": "string",
"description": "Name of the merchant"
},
"addDatetime": {
"type": "string",
"description": "Timestamp when the claim was added",
"format": "date-time"
},
"category": {
"type": "string",
"description": "Category of the claim"
}
}
}
}
}
}
}lynx.claimUpdated
{
"data": {
"eventType": "claim.claimUpdated",
"createdAt": "2026-02-18T10:30:45.123Z",
"tags": [
{
"name": "source",
"value": "member_portal"
},
{
"name": "priority",
"value": "high"
}
],
"clientOrg": {
"name": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "3f50436491"
},
"memberClaim": {
"claimNumber": "CLM-2026-00123",
"memberAccount": {
"id": "e008a16d-54a8-4eea-9480-116b21c164f7"
},
"memberBankAccount": {
"id": "4dbdba69-4875-47c5-a663-04d9aee9ee91"
},
"status": "PENDING",
"statusReason": "Awaiting review",
"claimAmount": 379.00,
"approvedAmount": 0.00,
"expenseDate": "2026-02-15",
"reimbursementType": "DIRECT_DEPOSIT",
"merchantType": "PHARMACY",
"merchantName": "City Pharmacy",
"addDatetime": "2026-02-18T10:30:00.000Z",
"category": "PRESCRIPTION"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "MemberClaimEvent",
"description": "Event for claim related events: claim.created and claim.updated",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "MemberClaimEventData containing claim information",
"required": ["eventType", "createdAt", "clientOrg", "member", "memberClaim"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["claim.created", "claim.updated"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrg": {
"type": "object",
"description": "Client organization information",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the client organization"
}
}
},
"member": {
"type": "object",
"description": "Member information",
"required": ["clientMemberId"],
"properties": {
"clientMemberId": {
"type": "string",
"description": "Unique client-side identifier for the member"
}
}
},
"memberClaim": {
"type": "object",
"description": "Claim information",
"required": ["claimNumber", "status"],
"properties": {
"claimNumber": {
"type": "string",
"description": "Unique identifier for the claim"
},
"memberAccount": {
"type": "object",
"description": "Member account information",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member account",
"format": "uuid"
}
}
},
"memberBankAccount": {
"type": "object",
"description": "Member bank account information",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member bank account",
"format": "uuid"
}
}
},
"status": {
"type": "string",
"description": "Status of the claim"
},
"statusReason": {
"type": "string",
"description": "Reason for the current status"
},
"claimAmount": {
"type": "number",
"description": "Amount claimed"
},
"approvedAmount": {
"type": "number",
"description": "Amount approved for reimbursement"
},
"expenseDate": {
"type": "string",
"description": "Date of the expense",
"format": "date"
},
"reimbursementType": {
"type": "string",
"description": "Type of reimbursement"
},
"merchantType": {
"type": "string",
"description": "Type of merchant"
},
"merchantName": {
"type": "string",
"description": "Name of the merchant"
},
"addDatetime": {
"type": "string",
"description": "Timestamp when the claim was added",
"format": "date-time"
},
"category": {
"type": "string",
"description": "Category of the claim"
}
}
}
}
}
}
}lynx.clientOrgApplicationStatusChangeEvent
{
"data": {
"eventType": "lynx.clientOrgApplicationStatusChangeEvent",
"createdAt": "2026-02-18T14:25:30.456Z",
"tags": [
{
"name": "source",
"value": "admin_portal"
},
{
"name": "priority",
"value": "high"
}
],
"clientOrgName": "Health_Plan_ABC_Division",
"childClientOrgName": "Health_Plan_ABC_Division_Child",
"clientOrgApplicationStatus": "App_Awaiting_Documents",
"clientOrgApplicationStatusReason": "Additional documentation required for verification",
"documentsRequired": [
"ein_verification",
"business_license",
"incorporation_certificate"
]
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ClientOrgApplicationStatusChangedEvent",
"description": "Event triggered when a Client Org Application status is updated",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "ClientApplicationStatusChangedEventData containing application status information",
"required": ["eventType", "createdAt", "clientOrgName", "clientOrgApplicationStatus"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["clientorg.application.status.changed"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrgName": {
"type": "string",
"description": "The name of the client organization"
},
"childClientOrgName": {
"type": "string",
"description": "The name of the child client organization"
},
"clientOrgApplicationStatus": {
"type": "string",
"description": "Status of the client organization application",
"enum": [
"App_Pending",
"App_Awaiting_Documents",
"App_Approved",
"Failed",
"App_Pending_Review",
"App_Ready",
"New"
]
},
"clientOrgApplicationStatusReason": {
"type": "string",
"description": "Reason for the current application status"
},
"documentsRequired": {
"type": "array",
"description": "List of documents required for application processing",
"items": {
"type": "string"
}
}
}
}
}
}lynx.commerceOrderAcknowledgement
{
"data": {
"eventType": "lynx.commerceOrderAcknowledgement",
"createdAt": "2025-01-30T09:00:40.163Z",
"tags": [
{
"name": "source",
"value": "commerce_system"
},
{
"name": "priority",
"value": "normal"
},
{
"name": "idempotency_key",
"value": "cf82639c-1e3sbd6-4dd1s51-98a721-0e452aa6a2bk1a566"
}
],
"clientOrg": {
"name": "BF Dev Org 22"
},
"member": {
"clientMemberId": "59130ab8-100a-485c-adc9-8d5ddf0a89f7"
},
"memberAccounts": [
{
"id": "752bfa32-6237-4fbc-b30c-458133566acd",
"amount": 103.89
}
],
"externalCard": null,
"memberCommerceOrder": {
"orderNumber": "ORD01000000445",
"datetime": "2025-01-30T08:58:45.324Z",
"totalAmount": 103.89,
"orderLines": [
{
"quantity": 2,
"sku": "257758_EA",
"status": "In Progress",
"trackingNumber": null,
"expectedDeliveryDatetime": null,
"shipmentDate": null,
"deliveryDatetime": null
},
{
"quantity": 2,
"sku": "830950_BT",
"status": "In Progress",
"trackingNumber": null,
"expectedDeliveryDatetime": null,
"shipmentDate": null,
"deliveryDatetime": null
},
{
"quantity": 3,
"sku": "762703_PK",
"status": "Cancelled",
"trackingNumber": null,
"expectedDeliveryDatetime": null,
"shipmentDate": null,
"deliveryDatetime": null
}
]
},
"shippingAddress": {
"line1": "3299 Woodburn Rd",
"line2": "32",
"city": "Annandale",
"stateProvince": "VA",
"country": "US",
"postalCode": "22003",
"postalCodeExtension": null
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "CommerceOrderEvent",
"description": "Event for commerce order related events: acknowledgement, shipped and delivered scenarios",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "CommerceOrderEventData containing order information",
"required": ["eventType", "createdAt", "clientOrg", "member", "memberCommerceOrder", "shippingAddress"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["commerce.order.acknowledged", "commerce.order.shipped", "commerce.order.delivered"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrg": {
"type": "object",
"description": "Client organization information",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the client organization"
}
}
},
"member": {
"type": "object",
"description": "Member information",
"required": ["clientMemberId"],
"properties": {
"clientMemberId": {
"type": "string",
"description": "Unique client-side identifier for the member"
}
}
},
"memberAccounts": {
"type": "array",
"description": "List of member accounts used for payment",
"items": {
"type": "object",
"required": ["id", "amount"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member account",
"format": "uuid"
},
"amount": {
"type": "number",
"description": "Amount paid from this account"
}
}
}
},
"externalCard": {
"type": "object",
"description": "External card information used for payment",
"required": ["cardId", "amount"],
"properties": {
"cardId": {
"type": "string",
"description": "Card identifier"
},
"amount": {
"type": "number",
"description": "Amount paid with this card"
}
}
},
"memberCommerceOrder": {
"type": "object",
"description": "Commerce order information",
"required": ["orderNumber", "datetime", "totalAmount", "orderLines"],
"properties": {
"orderNumber": {
"type": "string",
"description": "Unique identifier for the order"
},
"datetime": {
"type": "string",
"description": "Timestamp when the order was placed",
"format": "date-time"
},
"totalAmount": {
"type": "number",
"description": "Total amount of the order"
},
"orderLines": {
"type": "array",
"description": "List of order line items",
"items": {
"type": "object",
"required": ["quantity", "sku", "status"],
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity of the item ordered"
},
"sku": {
"type": "string",
"description": "Stock keeping unit identifier for the product"
},
"status": {
"type": "string",
"description": "Status of the order line",
"enum": ["PENDING", "ACKNOWLEDGED", "SHIPPED", "DELIVERED", "CANCELLED"]
},
"trackingNumber": {
"type": "string",
"description": "Tracking number for shipment"
},
"expectedDeliveryDatetime": {
"type": "string",
"description": "Expected delivery date and time",
"format": "date-time"
},
"shipmentDate": {
"type": "string",
"description": "Date when the item was shipped",
"format": "date-time"
},
"deliveryDatetime": {
"type": "string",
"description": "Date and time when the item was delivered",
"format": "date-time"
}
}
}
}
}
},
"shippingAddress": {
"type": "object",
"description": "Shipping address information",
"required": ["line1", "city", "stateProvince", "country", "postalCode"],
"properties": {
"line1": {
"type": "string",
"description": "Address line 1"
},
"line2": {
"type": "string",
"description": "Address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"stateProvince": {
"type": "string",
"description": "State or province"
},
"country": {
"type": "string",
"description": "Country code"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"postalCodeExtension": {
"type": "string",
"description": "Postal code extension"
}
}
}
}
}
}
}lynx.commerceOrderShipment
{
"data": {
"eventType": "lynx.commerceOrderShipment",
"createdAt": "2025-01-30T09:00:40.163Z",
"tags": [
{
"name": "source",
"value": "commerce_system"
},
{
"name": "priority",
"value": "normal"
},
{
"name": "idempotency_key",
"value": "cf82639c-1e3sbd6-4dd1s51-98a721-0e452aa6a2bk1a566"
}
],
"clientOrg": {
"name": "BF Dev Org 22"
},
"member": {
"clientMemberId": "59130ab8-100a-485c-adc9-8d5ddf0a89f7"
},
"memberAccounts": [
{
"id": "752bfa32-6237-4fbc-b30c-458133566acd",
"amount": 103.89
}
],
"externalCard": null,
"memberCommerceOrder": {
"orderNumber": "ORD00000000065",
"datetime": "2024-07-17T06:47:47.267Z",
"totalAmount": 304.60,
"orderLines": [
{
"quantity": 2,
"sku": "649273_CS",
"status": "Shipped",
"trackingNumber": "1Z XXX XXX YY ZZZZ ZZZC",
"expectedDeliveryDatetime": "2024-07-20T00:00:00.000Z",
"shipmentDate": "2024-07-17T00:00:00.000Z",
"deliveryDatetime": "2024-09-18T14:01:33.495Z"
},
{
"quantity": 2,
"sku": "892681_CS",
"status": "Shipped",
"trackingNumber": "1Z XXX XXX YY ZZZZ ZZZC",
"expectedDeliveryDatetime": "2024-07-20T00:00:00.000Z",
"shipmentDate": "2024-07-17T00:00:00.000Z",
"deliveryDatetime": "2024-09-18T14:01:33.495Z"
}
]
},
"shippingAddress": {
"line1": "3299 Woodburn Rd",
"line2": "32",
"city": "Annandale",
"stateProvince": "VA",
"country": "US",
"postalCode": "22003",
"postalCodeExtension": null
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "CommerceOrderEvent",
"description": "Event for commerce order related events: acknowledgement, shipped and delivered scenarios",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "CommerceOrderEventData containing order information",
"required": ["eventType", "createdAt", "clientOrg", "member", "memberCommerceOrder", "shippingAddress"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["commerce.order.acknowledged", "commerce.order.shipped", "commerce.order.delivered"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrg": {
"type": "object",
"description": "Client organization information",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the client organization"
}
}
},
"member": {
"type": "object",
"description": "Member information",
"required": ["clientMemberId"],
"properties": {
"clientMemberId": {
"type": "string",
"description": "Unique client-side identifier for the member"
}
}
},
"memberAccounts": {
"type": "array",
"description": "List of member accounts used for payment",
"items": {
"type": "object",
"required": ["id", "amount"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member account",
"format": "uuid"
},
"amount": {
"type": "number",
"description": "Amount paid from this account"
}
}
}
},
"externalCard": {
"type": "object",
"description": "External card information used for payment",
"required": ["cardId", "amount"],
"properties": {
"cardId": {
"type": "string",
"description": "Card identifier"
},
"amount": {
"type": "number",
"description": "Amount paid with this card"
}
}
},
"memberCommerceOrder": {
"type": "object",
"description": "Commerce order information",
"required": ["orderNumber", "datetime", "totalAmount", "orderLines"],
"properties": {
"orderNumber": {
"type": "string",
"description": "Unique identifier for the order"
},
"datetime": {
"type": "string",
"description": "Timestamp when the order was placed",
"format": "date-time"
},
"totalAmount": {
"type": "number",
"description": "Total amount of the order"
},
"orderLines": {
"type": "array",
"description": "List of order line items",
"items": {
"type": "object",
"required": ["quantity", "sku", "status"],
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity of the item ordered"
},
"sku": {
"type": "string",
"description": "Stock keeping unit identifier for the product"
},
"status": {
"type": "string",
"description": "Status of the order line",
"enum": ["PENDING", "ACKNOWLEDGED", "SHIPPED", "DELIVERED", "CANCELLED"]
},
"trackingNumber": {
"type": "string",
"description": "Tracking number for shipment"
},
"expectedDeliveryDatetime": {
"type": "string",
"description": "Expected delivery date and time",
"format": "date-time"
},
"shipmentDate": {
"type": "string",
"description": "Date when the item was shipped",
"format": "date-time"
},
"deliveryDatetime": {
"type": "string",
"description": "Date and time when the item was delivered",
"format": "date-time"
}
}
}
}
}
},
"shippingAddress": {
"type": "object",
"description": "Shipping address information",
"required": ["line1", "city", "stateProvince", "country", "postalCode"],
"properties": {
"line1": {
"type": "string",
"description": "Address line 1"
},
"line2": {
"type": "string",
"description": "Address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"stateProvince": {
"type": "string",
"description": "State or province"
},
"country": {
"type": "string",
"description": "Country code"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"postalCodeExtension": {
"type": "string",
"description": "Postal code extension"
}
}
}
}
}
}
}lynx.commerceOrderDelivered
{
"data": {
"eventType": "lynx.commerceOrderDelivered",
"createdAt": "2025-01-30T09:00:40.163Z",
"tags": [
{
"name": "source",
"value": "commerce_system"
},
{
"name": "priority",
"value": "normal"
},
{
"name": "idempotency_key",
"value": "cf82639c-1e3sbd6-4dd1s51-98a721-0e452aa6a2bk1a566"
}
],
"clientOrg": {
"name": "BF Dev Org 22"
},
"member": {
"clientMemberId": "59130ab8-100a-485c-adc9-8d5ddf0a89f7"
},
"memberAccounts": [
{
"id": "752bfa32-6237-4fbc-b30c-458133566acd",
"amount": 103.89
}
],
"externalCard": null,
"memberCommerceOrder": {
"orderNumber": "ORD00000000061",
"datetime": "2024-07-03T14:25:58.046Z",
"totalAmount": 2.93,
"orderLines": [
{
"quantity": 1,
"sku": "1209984_EA",
"status": "Delivered",
"trackingNumber": "one shipment",
"expectedDeliveryDatetime": "2024-07-10T00:00:00.000Z",
"shipmentDate": "2024-07-03T00:00:00.000Z",
"deliveryDatetime": "2024-07-18T00:00:00.000Z"
}
]
},
"shippingAddress": {
"line1": "3299 Woodburn Rd",
"line2": "32",
"city": "Annandale",
"stateProvince": "VA",
"country": "US",
"postalCode": "22003",
"postalCodeExtension": null
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "CommerceOrderEvent",
"description": "Event for commerce order related events: acknowledgement, shipped and delivered scenarios",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"description": "CommerceOrderEventData containing order information",
"required": ["eventType", "createdAt", "clientOrg", "member", "memberCommerceOrder", "shippingAddress"],
"properties": {
"eventType": {
"type": "string",
"description": "Type of event",
"enum": ["commerce.order.acknowledged", "commerce.order.shipped", "commerce.order.delivered"]
},
"createdAt": {
"type": "string",
"description": "Timestamp when the event was created",
"format": "date-time"
},
"tags": {
"type": "array",
"description": "List of tags associated with the event",
"items": {
"type": "object",
"required": ["name", "value"],
"properties": {
"name": {
"type": "string",
"description": "Name of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
}
}
},
"clientOrg": {
"type": "object",
"description": "Client organization information",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the client organization"
}
}
},
"member": {
"type": "object",
"description": "Member information",
"required": ["clientMemberId"],
"properties": {
"clientMemberId": {
"type": "string",
"description": "Unique client-side identifier for the member"
}
}
},
"memberAccounts": {
"type": "array",
"description": "List of member accounts used for payment",
"items": {
"type": "object",
"required": ["id", "amount"],
"properties": {
"id": {
"type": "string",
"description": "UUID of the member account",
"format": "uuid"
},
"amount": {
"type": "number",
"description": "Amount paid from this account"
}
}
}
},
"externalCard": {
"type": "object",
"description": "External card information used for payment",
"required": ["cardId", "amount"],
"properties": {
"cardId": {
"type": "string",
"description": "Card identifier"
},
"amount": {
"type": "number",
"description": "Amount paid with this card"
}
}
},
"memberCommerceOrder": {
"type": "object",
"description": "Commerce order information",
"required": ["orderNumber", "datetime", "totalAmount", "orderLines"],
"properties": {
"orderNumber": {
"type": "string",
"description": "Unique identifier for the order"
},
"datetime": {
"type": "string",
"description": "Timestamp when the order was placed",
"format": "date-time"
},
"totalAmount": {
"type": "number",
"description": "Total amount of the order"
},
"orderLines": {
"type": "array",
"description": "List of order line items",
"items": {
"type": "object",
"required": ["quantity", "sku", "status"],
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity of the item ordered"
},
"sku": {
"type": "string",
"description": "Stock keeping unit identifier for the product"
},
"status": {
"type": "string",
"description": "Status of the order line",
"enum": ["PENDING", "ACKNOWLEDGED", "SHIPPED", "DELIVERED", "CANCELLED"]
},
"trackingNumber": {
"type": "string",
"description": "Tracking number for shipment"
},
"expectedDeliveryDatetime": {
"type": "string",
"description": "Expected delivery date and time",
"format": "date-time"
},
"shipmentDate": {
"type": "string",
"description": "Date when the item was shipped",
"format": "date-time"
},
"deliveryDatetime": {
"type": "string",
"description": "Date and time when the item was delivered",
"format": "date-time"
}
}
}
}
}
},
"shippingAddress": {
"type": "object",
"description": "Shipping address information",
"required": ["line1", "city", "stateProvince", "country", "postalCode"],
"properties": {
"line1": {
"type": "string",
"description": "Address line 1"
},
"line2": {
"type": "string",
"description": "Address line 2"
},
"city": {
"type": "string",
"description": "City"
},
"stateProvince": {
"type": "string",
"description": "State or province"
},
"country": {
"type": "string",
"description": "Country code"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"postalCodeExtension": {
"type": "string",
"description": "Postal code extension"
}
}
}
}
}
}
}lynx.transactionReturned
{
"data": {
"eventType": "lynx.transactionReturned",
"member": {
"clientMemberId": "3f50436491"
},
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"transaction": {
"transactionAmount": "51.77",
"transactionDirection": "Debit",
"transactionType": "EcommerceBuy",
"transactionCategory": "DEPOSIT",
"referenceIdentifier": "TRANS000022521680",
"accountBalance": "125.00"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.transactionReturned"
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
}
},
"required": ["clientMemberId"]
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"transaction": {
"type": "object",
"properties": {
"transactionAmount": {
"type": "string",
"pattern": "^\\d+(\\.\\d{2})?$"
},
"transactionDirection": {
"enum": [
"Debit",
"Credit"
]
},
"transactionType": {
"type": "string"
},
"transactionCategory": {
"enum": [
"CONTRIBUTION",
"DISBURSEMENT",
"REDEMPTION",
"TRANSFER",
"DEPOSIT",
"WITHDRAWAL",
"COPORATE_ACTION",
"CARD",
"ADJUSTMENT",
"RETURN",
"FEE",
"MEMBER_FEE_REVENUE",
]
},
"referenceIdentifier": {
"type": "string"
},
"accountBalance": {
"type": "string",
"pattern": "^\\d+(\\.\\d{2})?$"
}
},
"required": ["transactionAmount", "transactionDirection", "transactionType",
"transactionCategory", "referenceIdentifier", "accountBalance"]
}
},
"required": ["eventType", "member", "clientOrg", "transaction"]
}
},
"required": ["data"]
}
lynx.phoneNumberPrimaryUpdate
{
"data": {
"eventType": "lynx.phoneNumberPrimaryUpdate",
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"member": {
"clientMemberId": "3f50436491",
"memberProducts": {
"productName": "HSA"
}
},
"newPrimaryPhone": {
"type": "MOBILE",
"typeDescription": "Mobile Phone",
"countryCode": "+1",
"phoneNumber": "555-123-4567",
"phoneExtension": "344",
"primaryIndicator": "true"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.phoneNumberPrimaryUpdate"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"memberProducts": {
"type": "object",
"properties": {
"productName": {
"type": "string"
}
},
"required": ["productName"]
}
},
"required": ["clientMemberId", "memberProducts"]
},
"newPrimaryPhone": {
"type": "object",
"properties": {
"type": {
"enum": [
"MOBILE",
"HOME",
"WORK"
]
},
"typeDescription": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"phoneExtension": {
"type": "string",
"nullable": true
},
"primaryIndicator": {
"type": "boolean"
}
},
"required": ["type", "typeDescription", "countryCode", "phoneNumber",
"primaryIndicator"]
}
},
"required": ["eventType", "clientOrg", "member", "newPrimaryPhone"]
}
},
"required": ["data"]
}
lynx.relatedPersonAdded
{
"data": {
"eventType": "lynx.relatedPersonAdded",
"member": {
"clientMemberId": "3f50436491",
"memberProducts": {
"productName": "HSA"
}
},
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"relatedPerson": {
"firstName": "John",
"lastName": "Doe",
"type": "BENEFICIARY"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.relatedPersonAdded"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"memberProducts": {
"type": "object",
"properties": {
"productName": {
"type": "string"
}
},
"required": ["productName"]
}
},
"required": ["clientMemberId", "memberProducts"]
},
"relatedPerson": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"type": {
"enum": [
"BENEFICIARY",
"DEPENDENT"
]
}
},
"required": ["firstName", "lastName", "type"]
}
},
"required": ["eventType", "clientOrg", "member", "relatedPerson"]
}
},
"required": ["data"]
}
lynx.relatedPersonUpdated
{
"data": {
"eventType": "lynx.relatedPersonUpdated",
"member": {
"clientMemberId": "3f50436491",
"memberProducts": {
"productName": "HSA"
}
},
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"relatedPerson": {
"firstName": "John",
"lastName": "Doe",
"type": "BENEFICIARY"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.relatedPersonUpdated"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"memberProducts": {
"type": "object",
"properties": {
"productName": {
"type": "string"
}
},
"required": ["productName"]
}
},
"required": ["clientMemberId", "memberProducts"]
},
"relatedPerson": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"type": {
"enum": [
"BENEFICIARY",
"DEPENDENT"
]
}
},
"required": ["firstName", "lastName", "type"]
}
},
"required": ["eventType", "clientOrg", "member", "relatedPerson"]
}
},
"required": ["data"]
}
lynx.relatedPersonDeleted
{
"data": {
"eventType": "lynx.relatedPersonDeleted",
"member": {
"clientMemberId": "3f50436491",
"memberProducts": {
"productName": "HSA"
}
},
"clientOrg": {
"clientOrgName": "Health_Plan_ABC_Division"
},
"relatedPerson": {
"firstName": "John",
"lastName": "Doe",
"type": "BENEFICIARY"
}
}
}{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"eventType": {
"const": "lynx.relatedPersonDeleted"
},
"clientOrg": {
"type": "object",
"properties": {
"clientOrgName": {
"type": "string"
}
},
"required": ["clientOrgName"]
},
"member": {
"type": "object",
"properties": {
"clientMemberId": {
"type": "string"
},
"memberProducts": {
"type": "object",
"properties": {
"productName": {
"type": "string"
}
},
"required": ["productName"]
}
},
"required": ["clientMemberId", "memberProducts"]
},
"relatedPerson": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"type": {
"enum": [
"BENEFICIARY",
"DEPENDENT"
]
}
},
"required": ["firstName", "lastName", "type"]
}
},
"required": ["eventType", "clientOrg", "member", "relatedPerson"]
}
},
"required": ["data"]
}Updated about 1 month ago