Receiving OpenAI API status update information through a Webhook

API
1

I would like to setup a webhook endpoint in a Java/Spring boot application to get updates about the status of the API, especially about incidents.

I know it is possible to register a webhook URL in the status page https://status.openai.com, but the actual payload of that webhook is not specified.

Does anybody know what the actual payload structure is?
Thanks

2 Likes
2

Looks like they’re just using statuspage (It’s an Atlassian product), whose documentation is on their website. I would link it here, but this forum doesn’t allow links for some ridiculous reason.

If you submit the little popup form for webhook notifications on the OpenAI status page, you get an email with a link to the statuspage docs.

3

Hi and welcome to the Developer Forum!

Links are restricted for new posters to help reduce spam, 475k users it quite a handful. If you make use of the forum for a short while you will be granted TL-2 status and your posting restrictions will be lifted.

4

Many thanks! This is clearer now

1 Like
5

This is what openai status response look like

  • Incindent response
{"meta": {"unsubscribe": "http://status.openai.com/?unsubscribe=7dlgm1w8jwy9", "documentation": "https://help.statuspage.io/knowledge_base/topics/webhook-notifications", "generated_at": "2024-03-15T22:29:51.402Z"}, "page": {"id": "jbxzcdv9xc4d", "status_indicator": "none", "status_description": "All Systems Operational"}, "incident": {"name": "Elevated error rate in Assistants API", "status": "resolved", "created_at": "2024-03-15T15:18:41.752-07:00", "updated_at": "2024-03-15T15:24:46.323-07:00", "monitoring_at": null, "resolved_at": "2024-03-15T15:24:46.309-07:00", "impact": "minor", "shortlink": "https://stspg.io/gzqklj7cmst3", "scheduled_for": null, "scheduled_until": null, "scheduled_remind_prior": false, "scheduled_reminded_at": null, "impact_override": null, "scheduled_auto_in_progress": false, "scheduled_auto_completed": false, "metadata": {}, "started_at": "2024-03-15T15:18:41.747-07:00", "reminder_intervals": null, "id": "rqhqz7sg4q3v", "page_id": "jbxzcdv9xc4d", "incident_updates": [{"status": "resolved", "body": "We have now resolved this issue.", "created_at": "2024-03-15T15:24:46.309-07:00", "wants_twitter_update": false, "twitter_updated_at": null, "updated_at": "2024-03-15T15:24:46.309-07:00", "display_at": "2024-03-15T15:24:46.309-07:00", "deliver_notifications": true, "tweet_id": null, "id": "ncv2mz2kb2yq", "incident_id": "rqhqz7sg4q3v", "custom_tweet": null, "affected_components": [{"code": "scd0s93nldpb", "name": "API", "old_status": "degraded_performance", "new_status": "operational"}]}, {"status": "investigating", "body": "We are currently investigating this issue.", "created_at": "2024-03-15T15:18:41.818-07:00", "wants_twitter_update": false, "twitter_updated_at": null, "updated_at": "2024-03-15T15:18:41.818-07:00", "display_at": "2024-03-15T15:18:41.818-07:00", "deliver_notifications": true, "tweet_id": null, "id": "mq5t3pgjhzk8", "incident_id": "rqhqz7sg4q3v", "custom_tweet": null, "affected_components": [{"code": "scd0s93nldpb", "name": "API", "old_status": "operational", "new_status": "degraded_performance"}]}], "postmortem_body": null, "postmortem_body_last_updated_at": null, "postmortem_ignored": false, "postmortem_published_at": null, "postmortem_notified_subscribers": false, "postmortem_notified_twitter": false, "components": [{"status": "operational", "name": "API", "created_at": "2021-02-12T12:31:47.393-08:00", "updated_at": "2024-03-15T15:24:46.281-07:00", "position": 1, "description": "All OpenAI API services at api.openai.com", "showcase": true, "start_date": "2021-02-11T00:00:00.000-08:00", "id": "scd0s93nldpb", "page_id": "jbxzcdv9xc4d", "group_id": null}]}}
  • Component Update
{"meta": {"unsubscribe": "http://status.openai.com/?unsubscribe=7dlgm1w8jwy9", "documentation": "https://help.statuspage.io/knowledge_base/topics/webhook-notifications", "generated_at": "2024-03-15T22:50:55.259Z"}, "page": {"id": "jbxzcdv9xc4d", "status_indicator": "minor", "status_description": "Partially Degraded Service"}, "component": {"status": "degraded_performance", "name": "API", "created_at": "2021-02-12T20:31:47.393Z", "updated_at": "2024-03-15T22:50:22.404Z", "position": 1, "description": "All OpenAI API services at api.openai.com", "showcase": true, "start_date": "2021-02-11T08:00:00.000Z", "id": "scd0s93nldpb", "page_id": "jbxzcdv9xc4d", "group_id": null}, "component_update": {"old_status": "operational", "new_status": "degraded_performance", "created_at": "2024-03-15T22:50:22.411Z", "component_type": "Component", "state": "sn_created", "id": "h1kr9cktrhzz", "component_id": "scd0s93nldpb"}}
1 Like