Submit a push delivery receipt

POST https://z.u1v.ru/api/v1/push/delivery_receipt

Record a client-side lifecycle receipt for a push event.

Usage examples

curl

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://z.u1v.ru/api/v1/push/delivery_receipt \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode push_event_id=push-event-1 \
    --data-urlencode receipt_type=push_received \
    --data-urlencode device_instance_id=device-1 \
    --data-urlencode client_time=1786420800000

Parameters

push_event_id string required

Example: "push-event-1"

Push event or delivery trace identifier.

receipt_type string required

Example: "push_received"

Client-observed push lifecycle stage. Must be one of: "push_received", "notification_displayed", "event_synced", "message_opened", "duplicate_ignored".

device_instance_id string | null optional

Example: "device-1"

Stable application device identifier.

client_time integer | null optional

Example: 1786420800000

Optional client timestamp in milliseconds.

Response

Example response(s)

Successful response from a UCS extension endpoint. Endpoint-specific fields are returned alongside the standard Zulip success envelope.

{
    "msg": "",
    "result": "success"
}

API documentation home

Messages

Scheduled messages

Message reminders

Drafts

Navigation views

Channels

Users

Invitations

Server & organizations

Real-time events

Interactive bots

Specialty endpoints

Back to Zulip

Submit a push delivery receipt

Usage examples

Parameters

Response

Example response(s)