Notifications

Ideon keeps your system informed of key events so that Enrollment processes work smoothly.

Adding a new layer of communication between oneself and the carrier requires clear an prompt communication. Using the GET endpoints, a platform integrating can poll at any moment to get the latest information on resources in the Ideon API. While polling is a fine approach, Ideon also supports pushing of information to you via a webhook.

Webhook Subscription

Subscribing to the webhook as part of the integration requires a few steps:

  1. Set up an URL endpoint to receive the request delivered from the webhook.

  2. Share that URL with Ideon, along with any required Headers.

  3. That's it! Ideon will add the subscription and you will start to receive updates to your system.

Webhook Request

There are two types of notifications that the webhook delivers today. One upon the change of a state of the Coverage Period and the other for the creation of Enrollment Problems for a Coverage Period.

Coverage Period State

Coverage Periods change states as they move through the process with Ideon. The potential states are:

  • initial - Ideon has received the Coverage Period but has yet to take action.

  • configuration - Ideon is configuring the Coverage Period to the account structure.

  • test - Ideon is performing tests internally and/or with the Carrier.

  • production - Ideon is sending enrollment information to the Carrier.

  • expired - Ideon is no longer sending enrollment information to the Carrier.

Each time the Coverage Period state field is changed, the webhook is delivered with the following example request body:

Method: POST
{
    "type": "coverage_period.state_changed",
    "data": {
        "coverage_period": {
            "id": "d3ed1ba5-952a-4281-9863-e6f9c30b3d02",
            "external_identifier": "YOUR_COVERAGE_PERIOD_IDENTIFIER",
            "coverage_start_date": "2022-01-01",
            "coverage_end_date": "2022-12-31",
            "open_enrollment_end_date": null,
            "open_enrollment_start_date": null,
            "state": "test",
            "carrier_name": "anthem",
            "carrier_group_number": "00514938",
            "enrollment_type": "member_management",
            "next_send_time": null,
            "term_by_omission": null,
            "file_type": null
        }
    }
}

Enrollment Problems

Each time Enrollment Problems are encountered by the Ideon team and uploaded for review, the webhook is delivered with the following example request body:

Method: POST
{
    "type": "coverage_period.errors_processed",
    "data": {
        "errors": [
            {
                "id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
                "member_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
                "plan_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
                "coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
                "census_requests": [
                    {
                        "id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
                        "status": "synced",
                        "coverage_period_id": "a37ecd06-5d97-46e4-9b4e-dcde6a03246f",
                        "created_at": "2022-05-03T09:00:00-04:00"
                    }
                ],
                "severity": "info",
                "message": "Child dependent John Smith is missing from coverage. Please include the dependent.",
                "assignee": "partner",
                "discrepancy": {
                    "parameter": "social_security_number",
                    "carrier": "123456789",
                    "platform": "0123455678"
                },
                "status": "pending",
                "resolution": {},
                "comments": [],
                "created_at": "2022-07-28T19:45:35.660Z"
            }
        ]
    }
}

Last updated

Was this helpful?