GET
/
webhook-events
List available event types
curl --request GET \
  --url https://api.simiz.io/v1/webhook-events
{
  "events": [
    {
      "name": "transaction.created",
      "description": "A new transaction was created",
      "category": "transaction"
    },
    {
      "name": "transaction.completed",
      "description": "A payment was successfully completed",
      "category": "transaction"
    },
    {
      "name": "transaction.failed",
      "description": "A payment failed",
      "category": "transaction"
    },
    {
      "name": "transaction.expired",
      "description": "A payment expired",
      "category": "transaction"
    },
    {
      "name": "refund.created",
      "description": "A refund was created",
      "category": "refund"
    },
    {
      "name": "refund.completed",
      "description": "A refund was completed",
      "category": "refund"
    },
    {
      "name": "refund.failed",
      "description": "A refund failed",
      "category": "refund"
    },
    {
      "name": "subscription.created",
      "description": "A subscription was created",
      "category": "subscription"
    },
    {
      "name": "subscription.activated",
      "description": "A subscription was activated",
      "category": "subscription"
    },
    {
      "name": "subscription.cancelled",
      "description": "A subscription was cancelled",
      "category": "subscription"
    },
    {
      "name": "subscription.past_due",
      "description": "A subscription payment is past due",
      "category": "subscription"
    },
    {
      "name": "payment_link.paid",
      "description": "A payment link was paid",
      "category": "payment_link"
    },
    {
      "name": "checkout.completed",
      "description": "A checkout session was completed",
      "category": "checkout"
    },
    {
      "name": "checkout.expired",
      "description": "A checkout session expired",
      "category": "checkout"
    }
  ]
}

Response

200 - application/json

List of event types

events
object[]