Webhooks

payment.updated

A payment changed. previous_attributes holds the old value of each attribute that changed. A status change is its own _changed event, so a save that changes a status and another field sends both. An archive or restore sends only its .deleted or .restored event, even when the same save changed other fields.

postWebhookpayment.updated

Headers

Topkey-Signaturestring required

t=<unix>,v1=<hex>: see Verifying signatures in the Webhooks section of the introduction.

Payload

idstring required

evt_…. Delivery is at least once: dedupe on this.

object'event' required

api_version'v1' required

createdinteger required

When the change happened, in Unix seconds.

type'payment.updated' required

The event type.

livemodeboolean required

false outside production.

pending_webhooksinteger required

Deliveries of this event not yet successful when this one was sent, this one included. Earlier failed deliveries count, so resending a failed one sends 2.

Example payload

{
  "data": {
    "object": {
      "amount": {
        "currency": "USD"
      }
    }
  }
}

Response

Received. Anything else, including a redirect or no answer within 15 seconds, is a failure and is retried.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.