> ## Documentation Index
> Fetch the complete documentation index at: https://sudomock.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> The base URL is https://api.sudomock.com.
> Authenticate every request with the x-api-key header. Keys begin with sm_.
> A render returns the finished image at data.print_files[0].export_path. A request sent with is_async true returns a job_id to poll at GET /api/v1/jobs/{job_id}.
> Prefer the official SDKs over hand-written HTTP calls: npm install sudomock for Node, pip install sudomock for Python.

# Retrieve a list of events

> Reverse-chron delivery log spanning every endpoint the caller owns. The response groups rows by (job_id, event_type) into events.

<RequestExample>
  ```js Node.js theme={"theme":{"light":"github-light","dark":"vesper"}}
  const response = await fetch("https://api.sudomock.com/api/v1/webhook-endpoints/events", {
    method: "GET",
    headers: { "x-api-key": "sm_your_api_key" },
  });

  const data = await response.json();
  console.log(data);
  ```

  ```php PHP theme={"theme":{"light":"github-light","dark":"vesper"}}
  <?php

  $ch = curl_init("https://api.sudomock.com/api/v1/webhook-endpoints/events");
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "x-api-key: sm_your_api_key",
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"vesper"}}
  import requests

  response = requests.get(
      "https://api.sudomock.com/api/v1/webhook-endpoints/events",
      headers={"x-api-key": "sm_your_api_key"},
  )

  response.raise_for_status()
  print(response.json())
  ```

  ```ruby Ruby theme={"theme":{"light":"github-light","dark":"vesper"}}
  require "net/http"
  require "uri"

  uri = URI("https://api.sudomock.com/api/v1/webhook-endpoints/events")
  request = Net::HTTP::Get.new(uri)
  request["x-api-key"] = "sm_your_api_key"

  response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
    http.request(request)
  end

  puts response.body
  ```

  ```go Go theme={"theme":{"light":"github-light","dark":"vesper"}}
  package main

  import (
  	"fmt"
  	"io"
  	"net/http"
  )

  func main() {
  	req, err := http.NewRequest("GET", "https://api.sudomock.com/api/v1/webhook-endpoints/events", nil)
  	if err != nil {
  		panic(err)
  	}
  	req.Header.Set("x-api-key", "sm_your_api_key")

  	res, err := http.DefaultClient.Do(req)
  	if err != nil {
  		panic(err)
  	}
  	defer res.Body.Close()

  	body, _ := io.ReadAll(res.Body)
  	fmt.Println(string(body))
  }
  ```

  ```java Java theme={"theme":{"light":"github-light","dark":"vesper"}}
  import java.net.URI;
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;

  HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://api.sudomock.com/api/v1/webhook-endpoints/events"))
      .header("x-api-key", "sm_your_api_key")
      .GET()
      .build();

  HttpResponse<String> response = HttpClient.newHttpClient()
      .send(request, HttpResponse.BodyHandlers.ofString());

  System.out.println(response.body());
  ```

  ```csharp .NET theme={"theme":{"light":"github-light","dark":"vesper"}}
  using System.Net.Http;
  using System.Text;

  var request = new HttpRequestMessage(HttpMethod.Get, "https://api.sudomock.com/api/v1/webhook-endpoints/events");
  request.Headers.Add("x-api-key", "sm_your_api_key");

  var client = new HttpClient();
  var response = await client.SendAsync(request);

  Console.WriteLine(await response.Content.ReadAsStringAsync());
  ```

  ```bash cURL theme={"theme":{"light":"github-light","dark":"vesper"}}
  curl -X GET "https://api.sudomock.com/api/v1/webhook-endpoints/events" \
    -H "x-api-key: sm_your_api_key"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={"theme":{"light":"github-light","dark":"vesper"}}
  [
    {
      "id": "string",
      "endpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "event_type": "string",
      "status": "string",
      "attempt": 1,
      "created_at": "2026-01-01T00:00:00Z"
    }
  ]
  ```
</ResponseExample>


## OpenAPI

````yaml openapi.json GET /api/v1/webhook-endpoints/events
openapi: 3.1.0
info:
  title: SudoMock API
  description: >-
    Product mockup API. Render PSD templates, turn product photos into reusable
    mockups, create still images and videos, personalize text with fonts, and
    manage asynchronous jobs and signed webhooks.


    Every endpoint answers failures with the same envelope, so the status codes,
    the error_code values and the retry rule are documented once at
    https://sudomock.com/docs/errors rather than repeated per operation.
  version: 1.0.0
servers:
  - url: https://api.sudomock.com
    description: Production
security: []
tags:
  - name: PSD mockups
    description: Turn a Photoshop file into a reusable mockup, then render it.
  - name: Photo mockups
    description: Turn a product photo into a reusable mockup, then render artwork onto it.
  - name: Video mockups
    description: Render a mockup as a short video.
  - name: Fonts
    description: Upload and manage the fonts available to text layers.
  - name: Background removal
    description: Isolate a subject from its background as a standalone step.
  - name: Studio
    description: Open an embedded editor session and read what the customer produced in it.
  - name: Webhook endpoints
    description: Register signed endpoints and manage their secrets.
  - name: Webhook deliveries
    description: Inspect, replay and retry what those endpoints received.
  - name: Jobs
    description: Poll queued renders and read their results.
  - name: Account
    description: Read the current account, its plan and its remaining credits.
paths:
  /api/v1/webhook-endpoints/events:
    get:
      tags:
        - Webhook deliveries
      summary: Retrieve a list of events
      description: >-
        Reverse-chron delivery log spanning every endpoint the caller owns. The
        response groups rows by (job_id, event_type) into events.
      operationId: list_events_api_v1_webhook_endpoints_events_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
        - name: event_type
          in: query
          required: false
          schema:
            type: string
            description: >-
              Filter by event type. Either spelling of a photo-mockup event
              matches deliveries logged under the other.
          description: >-
            Filter by event type. Either spelling of a photo-mockup event
            matches deliveries logged under the other.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 100
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookDeliveryResponse'
                title: Response List Events Api V1 Webhook Endpoints Events Get
          headers:
            X-Webhook-Next-Cursor:
              description: Opaque cursor for the next page; absent on the last page.
              schema:
                type: string
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Node.js
          source: >-
            const response = await
            fetch("https://api.sudomock.com/api/v1/webhook-endpoints/events", {
              method: "GET",
              headers: { "x-api-key": "sm_your_api_key" },
            });


            const data = await response.json();

            console.log(data);
        - lang: PHP
          source: >-
            <?php


            $ch =
            curl_init("https://api.sudomock.com/api/v1/webhook-endpoints/events");

            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");

            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

            curl_setopt($ch, CURLOPT_HTTPHEADER, [
                "x-api-key: sm_your_api_key",
            ]);


            $response = curl_exec($ch);

            curl_close($ch);


            echo $response;
        - lang: Python
          source: |-
            import requests

            response = requests.get(
                "https://api.sudomock.com/api/v1/webhook-endpoints/events",
                headers={"x-api-key": "sm_your_api_key"},
            )

            response.raise_for_status()
            print(response.json())
        - lang: Ruby
          source: >-
            require "net/http"

            require "uri"


            uri =
            URI("https://api.sudomock.com/api/v1/webhook-endpoints/events")

            request = Net::HTTP::Get.new(uri)

            request["x-api-key"] = "sm_your_api_key"


            response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do
            |http|
              http.request(request)
            end


            puts response.body
        - lang: Go
          source: "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\treq, err := http.NewRequest(\"GET\", \"https://api.sudomock.com/api/v1/webhook-endpoints/events\", nil)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treq.Header.Set(\"x-api-key\", \"sm_your_api_key\")\n\n\tres, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer res.Body.Close()\n\n\tbody, _ := io.ReadAll(res.Body)\n\tfmt.Println(string(body))\n}"
        - lang: Java
          source: |-
            import java.net.URI;
            import java.net.http.HttpClient;
            import java.net.http.HttpRequest;
            import java.net.http.HttpResponse;

            HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.sudomock.com/api/v1/webhook-endpoints/events"))
                .header("x-api-key", "sm_your_api_key")
                .GET()
                .build();

            HttpResponse<String> response = HttpClient.newHttpClient()
                .send(request, HttpResponse.BodyHandlers.ofString());

            System.out.println(response.body());
        - lang: .NET
          source: >-
            using System.Net.Http;

            using System.Text;


            var request = new HttpRequestMessage(HttpMethod.Get,
            "https://api.sudomock.com/api/v1/webhook-endpoints/events");

            request.Headers.Add("x-api-key", "sm_your_api_key");


            var client = new HttpClient();

            var response = await client.SendAsync(request);


            Console.WriteLine(await response.Content.ReadAsStringAsync());
        - lang: cURL
          source: >-
            curl -X GET
            "https://api.sudomock.com/api/v1/webhook-endpoints/events" \
              -H "x-api-key: sm_your_api_key"
components:
  schemas:
    WebhookDeliveryResponse:
      properties:
        id:
          type: string
          examples:
            - 3d682132-5477-4ffc-b33d-6e750c9c9f1f
        endpoint_id:
          type: string
          examples:
            - b5cd6284-f6a0-4cfc-94df-781353e30dfd
        job_id:
          type: string
          examples:
            - 4a4bfe21-d9d2-43a4-9877-b6ca4aec4349
        event_type:
          type: string
          examples:
            - render.succeeded
        status:
          type: string
          examples:
            - delivered
        http_status:
          anyOf:
            - type: integer
            - type: 'null'
          examples:
            - 200
        attempt:
          type: integer
          examples:
            - 0
        last_error:
          anyOf:
            - type: string
            - type: 'null'
        created_at:
          type: string
          format: date-time
          examples:
            - '2026-09-18T09:24:12.615000Z'
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          examples:
            - '2026-09-18T09:24:12.983000Z'
      type: object
      required:
        - id
        - endpoint_id
        - job_id
        - event_type
        - status
        - attempt
        - created_at
      title: WebhookDeliveryResponse
      description: A single delivery-attempt log row.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key with sm_ prefix. Get your key at
        https://sudomock.com/dashboard/api-keys

````