Skip to main content
Open

Enhance Subscription API notification Payload with Delivery Failure Reason

Related products:APIs
  • Aug 27, 2024 10:04 AM UTC
  • 4 replies
  • 1366 views

fabito
Forum|alt.badge.img+2

We are currently experiencing delivery failures for our subscriptions. While the notification payload provides valuable information such as the subscription ID and failed item ID, it lacks the essential detail of the delivery failure reason. This information is crucial for us to effectively troubleshoot and resolve delivery issues.

{
    "schema_version": "0.0.1",
    "subscription_id": "5ba3b46d-5eb5-4ec5-a3c7-8faf6c906014",
    "topic": "delivery.failed",
    "name": "elegant dragonite",
    "result": {
      "item_id": "20240826_223522_66_24b7"
    },
    "timestamp": "2024-08-27T04:09:45+00:00"
  }
 

 

Proposed Enhancement:

  1. Include Failure Reason: Add a new field to the notification payload that clearly specifies the reason for the delivery failure. This could include but is not limited to:
    • Item Errors: Invalid item format, missing required data, or processing errors.
  2. Provide Detailed Information: If possible, include additional details related to the failure reason to aid in troubleshooting. For example:

            {
                "id": "70455fea-1706-499d-8795-dd7c7293f900",
                "status": "failed",
                "properties": {
                    "item_id": "20240826_223522_66_24b7",
                    "item_types": [
                        "PSScene"
                    ]
                },
                "created": "2024-08-27T03:56:17.715664Z",
                "updated": "2024-08-27T04:09:45.144083Z",
                "completed": "2024-08-27T04:09:45.144083Z",
                "errors": {
                    "reason": "Processing failed",
                    "details": [
                        "could not collect necessary data for task (code: FAILURE_CODE_UNSCHEDULABLE Harmonize_v1)"
                    ]
                },
                "outputs": []
            }
     

We believe that incorporating delivery failure reasons into the notification payload will greatly enhance the usability and effectiveness of your service. Thank you for considering this feature request.

4 replies

mirons
Community Manager 🌎
Forum|alt.badge.img+6
  • Community Manager 🌎
  • Aug 27, 2024 4:09 PM UTC

Thank you @fabito for the detailed feedback.

 

Are you currently blocked because of these subscriptions failures, or have you found the issue, for the time being?


fabito
Forum|alt.badge.img+2
  • Author
  • ‎‎ 🌱
  • Aug 27, 2024 10:02 PM UTC

@mirons ,

 

We are not blocked, we learned we can get the failure reason by invoking the Subscription API results endpoint.
 


elyhienrich
Community Manager 🌎
Forum|alt.badge.img+17
  • Community Manager 🌎
  • Sep 9, 2024 8:19 PM UTC
New→Open

elyhienrich
Community Manager 🌎
Forum|alt.badge.img+17
  • Community Manager 🌎
  • Sep 9, 2024 8:19 PM UTC

This idea is under review and open for discussion and voting. This is the investigation stage when we gather more information.