Outcomes

Subscribe to bid-outcome webhooks

Register an HTTPS endpoint to receive signed events when an offer's status changes (and when checkout completes). The response includes the signing secret exactly once. Deliveries are retried 3 times inline, then up to 8 more times over ~21h with exponential backoff; 20 consecutive failures disable the webhook. At most 10 active webhooks per caller.

post/api/v1/webhooks

Request

  • Base URL: https://www.upgradeagent.ai
  • URL: https://www.upgradeagent.ai/api/v1/webhooks
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://www.upgradeagent.ai/api/oauth/authorize, token URL https://www.upgradeagent.ai/api/oauth/token, scopes: mcp)
    • HTTP bearer

Request body

urlstring required

HTTPS endpoint on a public host. http, localhost, private/link-local addresses and credentials in the URL are rejected (400 WEBHOOK_URL_REJECTED).

eventsstring[]

Events to receive. Default: all.

quoteIdstring

Scope to one quote this caller owns (pending quotes allowed). Omit to receive events for every quote the caller owns.

Response

Webhook created — store secret now.

idstring required
urlstring required
eventsstring[] required
quoteIdstring nullable required

Bound quote, or null for all of the caller's quotes.

activeboolean required

False once auto-disabled after 20 consecutive failed deliveries.

createdAtstring required
lastDeliveryAtstring nullable required

Last successful (2xx) delivery.

failureCountinteger required

Consecutive failed deliveries.

secretstring required

The signing secret — shown ONCE. Store it; it is kept encrypted and never returned again.

Changes

No recorded changes to this operation across all 1 revision of this API.