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

# Send a test event

> Queue a `ping` event so you can confirm the endpoint is reachable and your signature verification works before relying on it.

**Constraints:**
- Delivery is asynchronous — poll the delivery log for the returned `delivery.id` to see the outcome.



## OpenAPI

````yaml /openapi/textsetu.json post /projects/{projectId}/webhooks/{endpointId}/test
openapi: 3.1.0
info:
  title: TextSetu API
  version: 1.2.0
  description: >-
    Public REST API for TextSetu. Authenticate with a Personal Access Token
    (tsu_pat_…) or a project token (tsu_proj_…) via the `Authorization: Bearer
    <token>` header.


    **Authorization is permission-based.** Every token carries an explicit
    allow-list of RBAC permission keys (e.g. `translation_read`), and each
    endpoint declares the permission it requires (`x-permission`). A token's
    effective access is its underlying authority ∩ its allow-list — a PAT is
    further bounded by its owner's role-based permissions, so it can only
    narrow, never exceed, what the owner already has. A project token is bound
    to a single project. There are no coarse read/write/manage scopes.


    **Response envelope.** Every endpoint returns `{ "success": true, "data": …
    }` on success and `{ "success": false, "error": { "code", "message" } }` on
    failure.


    **Rate limit.** 600 requests/minute, keyed by token (or by IP when
    unauthenticated). Exceeding it returns 429 with the standard error envelope.
servers:
  - url: https://api.textsetu.com/api/v1
    description: Production
  - url: /api/v1
    description: This server (self-hosted / same-origin)
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Read project metadata — settings, key separator, and the
      approval/branching flags that shape how the other endpoints behave.
  - name: Languages
    description: >-
      List and manage a project's target languages. Each language is referenced
      by its BCP-47 code; the source language is flagged separately.
  - name: Translations
    description: >-
      Manage a project's translations: create, read, update, and delete
      translation keys — the identifiers your app looks up, carrying metadata
      (description, tags, screenshot) — and set the translated value for a key
      in a given language. Value writes honor the project's approval workflow —
      non-approver writes land as `pending_review`.
  - name: Stats
    description: >-
      Per-language completeness and approval progress for a project — the
      numbers behind the dashboard.
  - name: Import/Export
    description: >-
      Bulk-load source files into a project or export the current translations.
      Supports the same file formats as the web app.
  - name: Branches
    description: >-
      Work on translations in isolation and merge them back. Branch reads/writes
      mirror the main endpoints but stage changes as a diff until merge. See the
      [branching guide](/docs/guides/branches).
  - name: Glossary
    description: >-
      Manage term bases — approved terminology and its translations — and check
      a string against them. See the [glossary guide](/docs/guides/glossary).
  - name: Translation Memory
    description: >-
      Reusable translation stores. Fuzzy-match and concordance-search prior
      translations to reuse them. See the [translation memory
      guide](/docs/guides/translation-memory).
  - name: AI
    description: >-
      Machine-translate a project with the org's configured AI engine (brand
      voice, glossary/TM grounding, and an optional review pass). Runs
      asynchronously — start a run and poll the returned `jobId`.
  - name: Webhooks
    description: >-
      Get notified when a project's translations change, instead of polling.
      Register an HTTPS endpoint, subscribe it to the events you care about, and
      TextSetu POSTs a signed payload whenever one occurs. Payloads follow the
      [Standard Webhooks](https://www.standardwebhooks.com) spec — verify the
      `webhook-signature` header with any compatible library. Delivery is
      at-least-once and unordered, so treat `webhook-id` as an idempotency key.
      Failed deliveries are retried five times over roughly seven hours, and
      every attempt is inspectable and replayable via the delivery log.
  - name: Meta
    description: Service-level and cross-cutting endpoints.
paths:
  /projects/{projectId}/webhooks/{endpointId}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test event
      description: >-
        Queue a `ping` event so you can confirm the endpoint is reachable and
        your signature verification works before relying on it.


        **Constraints:**

        - Delivery is asynchronous — poll the delivery log for the returned
        `delivery.id` to see the outcome.
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project id (UUID) or id-embedded path slug.
        - name: endpointId
          in: path
          required: true
          schema:
            type: string
      responses:
        '202':
          description: The queued test delivery.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      delivery:
                        type: object
                        properties:
                          id:
                            type: string
                            description: >-
                              Delivery id. Sent as the `webhook-id` header — use
                              it as your idempotency key.
                          endpointId:
                            type: string
                            description: Endpoint this was delivered to.
                          endpointUrl:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              The endpoint's URL, so listings need no second
                              lookup.
                          eventType:
                            type: string
                            description: Event type.
                            examples:
                              - branch.merged
                          eventId:
                            type: string
                            description: >-
                              Shared by every delivery fanned out from the same
                              source change, across endpoints.
                          status:
                            type: string
                            enum:
                              - pending
                              - success
                              - failed
                              - dead
                              - skipped
                            description: >-
                              `failed` means a retry is scheduled; `dead` means
                              attempts were exhausted or the response was
                              permanently unacceptable; `skipped` means it was
                              never sent.
                          attempt:
                            type: integer
                            description: Attempts made so far.
                          responseStatus:
                            anyOf:
                              - type: integer
                              - type: 'null'
                            description: >-
                              HTTP status returned, or null if no response was
                              received.
                          durationMs:
                            anyOf:
                              - type: integer
                              - type: 'null'
                            description: Last attempt duration.
                          error:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: Last failure reason.
                          nextAttemptAt:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: When the next retry is scheduled, if any.
                          deliveredAt:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: When a 2xx was first received.
                          replayOf:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              Set when this delivery is a replay of an earlier
                              one.
                          createdAt:
                            type: string
                            description: ISO 8601 timestamp.
                        required:
                          - id
                          - endpointId
                          - endpointUrl
                          - eventType
                          - eventId
                          - status
                          - attempt
                          - responseStatus
                          - durationMs
                          - error
                          - nextAttemptAt
                          - deliveredAt
                          - replayOf
                          - createdAt
                        additionalProperties: false
                    required:
                      - delivery
                    additionalProperties: false
        '404':
          description: Endpoint not found.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's
        granted RBAC permissions determine access; see each operation's
        `x-permission`.

````