Skip to main content
Tyktz

Developers

Build on Tyktz

A REST API for events, tickets, orders, and webhooks. Bring your own payment processor — keep your customers, your data, and your payouts.

Base URL: https://api.tyktz.com/v1Auth: Bearer sk_…Status: Private preview

This reference is a draft. Endpoints, request shapes, and event payloads may change before GA.

Events

Create and manage events.

get/eventsList events

Returns a paginated list of events for your account.

Parameters

  • limitqueryinteger
  • statusquerystring · draft | published | archived

Responses

200A page of events.
{
  "data": [
    {
      "id": "evt_01H9XYZ",
      "name": "Beachwalk Graduation 2026",
      "slug": "beachwalk-graduation-2026",
      "starts_at": "2026-06-01T18:30:00Z",
      "ends_at": "2026-06-01T18:30:00Z",
      "venue": "Beachwalk Plaza",
      "status": "draft",
      "created_at": "2026-06-01T18:30:00Z"
    }
  ],
  "has_more": false
}
post/eventsCreate an event

Request body

{
  "id": "evt_01H9XYZ",
  "name": "Beachwalk Graduation 2026",
  "slug": "beachwalk-graduation-2026",
  "starts_at": "2026-06-01T18:30:00Z",
  "ends_at": "2026-06-01T18:30:00Z",
  "venue": "Beachwalk Plaza",
  "status": "draft",
  "created_at": "2026-06-01T18:30:00Z"
}

Responses

201The created event.
{
  "id": "evt_01H9XYZ",
  "name": "Beachwalk Graduation 2026",
  "slug": "beachwalk-graduation-2026",
  "starts_at": "2026-06-01T18:30:00Z",
  "ends_at": "2026-06-01T18:30:00Z",
  "venue": "Beachwalk Plaza",
  "status": "draft",
  "created_at": "2026-06-01T18:30:00Z"
}
get/events/{id}Retrieve an event

Parameters

  • idpathrequiredstring

Responses

200OK
{
  "id": "evt_01H9XYZ",
  "name": "Beachwalk Graduation 2026",
  "slug": "beachwalk-graduation-2026",
  "starts_at": "2026-06-01T18:30:00Z",
  "ends_at": "2026-06-01T18:30:00Z",
  "venue": "Beachwalk Plaza",
  "status": "draft",
  "created_at": "2026-06-01T18:30:00Z"
}
404Not found
{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_missing",
    "message": "No event found with that ID."
  }
}

Tickets

Ticket types, inventory, and holds.

get/events/{id}/ticketsList ticket types for an event

Parameters

  • idpathrequiredstring

Responses

200Tickets
{
  "data": [
    {
      "id": "tkt_01H9ABC",
      "event_id": "evt_01H9XYZ",
      "name": "Guest Pass",
      "price_cents": 4500,
      "currency": "USD",
      "inventory": 250,
      "sold": 187
    }
  ]
}

Orders

Customer orders and refunds.

get/ordersList orders

Responses

200OK
{
  "data": [
    {
      "id": "ord_01H9PQR",
      "event_id": "evt_01H9XYZ",
      "buyer_email": "string",
      "total_cents": 9000,
      "currency": "USD",
      "status": "pending",
      "processor": "stripe",
      "processor_charge_id": "ch_3PA…",
      "created_at": "2026-06-01T18:30:00Z"
    }
  ]
}
post/orders/{id}/refundRefund an order

Issues a refund against the original payment processor. Bring-your-own-processor: Tyktz forwards the refund call to the connected processor on your behalf.

Parameters

  • idpathrequiredstring

Responses

200Refunded order
{
  "id": "ord_01H9PQR",
  "event_id": "evt_01H9XYZ",
  "buyer_email": "string",
  "total_cents": 9000,
  "currency": "USD",
  "status": "pending",
  "processor": "stripe",
  "processor_charge_id": "ch_3PA…",
  "created_at": "2026-06-01T18:30:00Z"
}

Attendees

Check-in and guest list management.

post/attendees/{id}/check-inCheck in an attendee

Parameters

  • idpathrequiredstring

Responses

200Checked in
{
  "id": "att_01H9LMN",
  "order_id": "ord_01H9PQR",
  "name": "Avery Chen",
  "ticket_id": "tkt_01H9ABC",
  "checked_in_at": "2026-06-01T18:30:00Z"
}

Webhooks

Real-time event notifications.

get/webhooksList webhook endpoints

Responses

200OK
post/webhooksRegister a webhook endpoint

Tyktz signs every webhook with HMAC-SHA256 in the `Tyktz-Signature` header. Verify the signature before trusting the payload. Events include: - `order.paid` - `order.refunded` - `attendee.checked_in` - `event.published`

Request body

{
  "url": "https://example.com/hooks/tyktz",
  "events": [
    "order.paid",
    "attendee.checked_in"
  ]
}

Responses

201Created