The dunning campaign has been completed for a customer

postWebhookdunning_campaign_finished

Headers

X-Lago-Signaturestring required

Example:AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=

Signature of the webhook payload. The format depends on X-Lago-Signature-Algorithm: hmac is the Base64 encoding of an HMAC-SHA256 digest of the payload, jwt is an RS256 JSON Web Token (a string starting with eyJ).

X-Lago-Signature-Algorithm'jwt' | 'hmac' required

Example:hmac

Algorithm used to generate the signature

X-Lago-Unique-Keystring uuid required

Example:1a901a90-1a90-1a90-1a90-1a901a901a90

Unique id of the webhook. It can be used for idempotency

Payload

webhook_type'dunning_campaign.finished' required

object_type'dunning_campaign' required

organization_idstring uuid required

Unique identifier of the organization, created by Lago.

Example payload

{
  "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "dunning_campaign": {
    "external_customer_id": "cus_0987654321",
    "dunning_campaign_code": "dun_code_1234",
    "overdue_balance_cents": 120,
    "overdue_balance_currency": "USD",
    "overdue_balances": [
      {
        "amount_cents": 120,
        "currency": "USD"
      }
    ]
  }
}

Response

Return a 200 status to indicate that the data was received successfully

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.