Webhook events

Inkwave sends these events to your webhook endpoints. An endpoint receives only the events it is subscribed to. To set one up, see the Webhooks guide; to check that a delivery really came from Inkwave, see Webhook signatures and delivery.

This page is generated from the event list in Inkwave's code, so it always matches what is sent.

The delivery

Every delivery is an HTTPS POST with a JSON body. The body has the same four fields for every event:

Fields may be added to data over time, so ignore fields you don't recognise rather than rejecting the delivery. A delivery carries no id of its own.

Test events

Send Test Event on an endpoint's page sends one of its event types with is_test set to true. A test delivery's data is not the event's fields: it is always the same two fields, whatever the event.

{
  "event_type": "subscription.created",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": true,
  "data": {
    "test": true,
    "publication_id": "7d2f6b1a-9c4e-4b3a-8f5d-2e6a1c9b4f7e"
  }
}

Events

subscription.created

Subscription created. A new reader joins your list.

When it fires: A new reader is added to your list: a sign-up, a reader you add by hand, or an access request you approve. If your publication asks readers to confirm their email, sent once, when they confirm. Not sent when a former subscriber rejoins, or when someone new joins straight onto a paid plan (that sends subscription.upgraded).

Data

Example delivery

{
  "event_type": "subscription.created",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "publication_subscriber_id": "5f0c2a8e-1b3d-4c6f-9a7e-2d4b6c8e0a1f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a",
    "email": "reader@example.com"
  }
}

subscription.deleted

Subscription deleted. A reader unsubscribes or is unsubscribed.

When it fires: A reader unsubscribes, from an email link or their preferences page, or you unsubscribe them.

Data

Example delivery

{
  "event_type": "subscription.deleted",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "publication_subscriber_id": "5f0c2a8e-1b3d-4c6f-9a7e-2d4b6c8e0a1f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a",
    "email": "reader@example.com"
  }
}

subscription.upgraded

Subscription upgraded. A reader starts a paid subscription.

When it fires: A reader completes a paid checkout, including one that starts with a free trial. Always sent together with subscription.tier.created.

Data

Example delivery

{
  "event_type": "subscription.upgraded",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "publication_subscriber_id": "5f0c2a8e-1b3d-4c6f-9a7e-2d4b6c8e0a1f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a",
    "email": "reader@example.com",
    "plan_id": "c3a7e1f9-5b2d-4a8c-9e6f-1d3b5a7c9e2f"
  }
}

subscription.downgraded

Subscription downgraded. A paid subscription is cancelled from your dashboard.

When it fires: You cancel a reader's paid subscription. It is set to end at the close of the current billing period; the reader keeps access until then. A subscription that ends in Stripe sends subscription.tier.deleted instead.

Data

Example delivery

{
  "event_type": "subscription.downgraded",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "publication_subscriber_id": "5f0c2a8e-1b3d-4c6f-9a7e-2d4b6c8e0a1f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a",
    "email": "reader@example.com"
  }
}

subscription.tier.created

Paid tier started. A reader starts a paid subscription (sent with subscription.upgraded).

When it fires: Sent on a paid checkout, alongside subscription.upgraded and with the same data. It is not sent when you create a tier.

Data

Example delivery

{
  "event_type": "subscription.tier.created",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "publication_subscriber_id": "5f0c2a8e-1b3d-4c6f-9a7e-2d4b6c8e0a1f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a",
    "email": "reader@example.com",
    "plan_id": "c3a7e1f9-5b2d-4a8c-9e6f-1d3b5a7c9e2f"
  }
}

subscription.tier.deleted

Paid subscription ended. A reader's paid subscription has ended in Stripe.

When it fires: Stripe reports the subscription deleted: a cancellation reaching the end of its period, or Stripe ending it (for example after failed payments, depending on your Stripe settings). It is not sent when you delete a tier.

Data

Example delivery

{
  "event_type": "subscription.tier.deleted",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "stripe_subscription_id": "sub_1QExample000000000000"
  }
}

post.sent

Post sent. A newsletter post finishes sending by email.

When it fires: An email send of a post completes. Not sent for a web-only post, a test email, or a send in which every message failed.

Data

Example delivery

{
  "event_type": "post.sent",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "newsletter_id": "1e5b9d3f-7a2c-4f6e-8b1d-3c5e7a9b2d4f",
    "publication_id": "7d2f6b1a-9c4e-4b3a-8f5d-2e6a1c9b4f7e",
    "title": "The Monday briefing",
    "recipient_count": 1250
  }
}

survey.response_submitted

Survey response submitted. A subscriber submits a survey response.

When it fires: A response is submitted by a reader who is a subscriber of this publication. A response that can't be tied to a subscriber does not send it.

Data

Example delivery

{
  "event_type": "survey.response_submitted",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "survey_id": "4a8c2e6f-1b3d-4f5a-9c7e-6b2d8f1a3c5e",
    "publication_subscriber_id": "5f0c2a8e-1b3d-4c6f-9a7e-2d4b6c8e0a1f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a"
  }
}

poll.response_submitted

Poll response submitted. A reader answers a poll.

When it fires: Any recorded poll answer, from an email or the website. A second answer from the same reader to the same poll is refused and sends nothing.

Data

Example delivery

{
  "event_type": "poll.response_submitted",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "poll_id": "8e2a6c1f-3b5d-4e7a-9f1c-5d3b7e9a2c4f",
    "option_id": "2c6e1a5f-9d3b-4c8e-a7f2-4b6d8e1c3a5f",
    "subscriber_id": "9b1e4d7a-3c5f-4e8b-a2d6-7f9c1e3b5d8a",
    "email": "reader@example.com"
  }
}

invoice.payment_succeeded

Payment succeeded. A reader's payment for a paid subscription succeeds.

When it fires: Stripe reports a paid invoice on your connected Stripe account.

Data

Example delivery

{
  "event_type": "invoice.payment_succeeded",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "stripe_invoice_id": "in_1QExample000000000000",
    "stripe_subscription_id": "sub_1QExample000000000000",
    "amount_paid": 9.5,
    "currency": "usd"
  }
}

invoice.payment_failed

Payment failed. A reader's payment for a paid subscription fails.

When it fires: Stripe reports a failed invoice payment on your connected Stripe account. Stripe retries the payment on its own schedule; each failed attempt it reports sends this again.

Data

Example delivery

{
  "event_type": "invoice.payment_failed",
  "created_at": "2026-01-15T09:30:00.000Z",
  "is_test": false,
  "data": {
    "stripe_invoice_id": "in_1QExample000000000000",
    "stripe_subscription_id": "sub_1QExample000000000000"
  }
}