stable · api · 0.1.0

Get a Notification Delivery outcome

GET /api/v1/notification-deliveries/{deliveryId}

Capability Domain: Notifications

Authentication

projectCredential (notifications:write)

Scope: notifications:write

Parameters and request body

X-Correlation-ID — header, optional
X-Correlation-ID schema
```
{
    "type": "string",
    "format": "uuid"
}
```

deliveryId — path, required

deliveryId schema

{
    "type": "string",
    "format": "uuid"
}

Responses and errors

Status	Description
`200`	Current email or channel Delivery outcome
`401`	Invalid or revoked Project Credential
`403`	Project Credential lacks the required scope
`422`	Request violates the public contract

200 schema

200 response schema

{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "required": [
                "id",
                "channel",
                "status",
                "attempts",
                "provider_status",
                "last_error_code"
            ],
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "channel": {
                    "type": "string",
                    "enum": [
                        "email",
                        "fcm",
                        "apns",
                        "line",
                        "web_push"
                    ]
                },
                "status": {
                    "type": "string",
                    "enum": [
                        "pending",
                        "retry",
                        "sent",
                        "rejected",
                        "suppressed",
                        "unknown",
                        "failed",
                        "accepted",
                        "unavailable",
                        "delivered",
                        "bounced",
                        "complained"
                    ]
                },
                "attempts": {
                    "type": "integer",
                    "minimum": 0
                },
                "provider_status": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "last_error_code": {
                    "type": [
                        "string",
                        "null"
                    ]
                }
            }
        }
    }
}

401 schema

401 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

422 schema

422 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

200 example

200 response example

{
    "data": {
        "id": "85000000-0000-4000-8000-000000000002",
        "channel": "fcm",
        "status": "sent",
        "attempts": 1,
        "provider_status": "accepted",
        "last_error_code": null
    }
}

Idempotency

Safe read; repeated requests do not change the Delivery.