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

# Replay a webhook event

> Requests that a stored event be sent to this subscription again. The event keeps its original `event_id`.

The subscription must be `active` and still include the event's type, or you get `409 WEBHOOK_SUBSCRIPTION_INACTIVE`. If the subscription's `phone_number_filter` excludes the number the event belongs to, you get `409 WEBHOOK_PHONE_NUMBER_EXCLUDED`.

Send an `Idempotency-Key` so you can safely retry this call.




## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/webhook-subscriptions/{subscription_id}/events/{event_id}/replay
openapi: 3.1.0
info:
  title: Blujay API
  version: 1.0.0
  description: >-
    The Blujay API lets you send and receive iMessage, RCS and SMS messages from
    your

    Blujay phone numbers, manage contacts, and receive real-time webhooks.


    Every response uses the same JSON envelope and carries a `trace_id` you can
    share

    with support. Authenticate with your workspace API key.
servers:
  - url: https://api.blujay.io
    description: Production
security:
  - PublicApiKey: []
tags:
  - name: Auth
    description: Check which workspace and credential a request is using.
  - name: Chats
    description: >-
      Direct and group conversations between your Blujay numbers and your
      contacts.
  - name: Messages
    description: Send, read, edit, unsend and retry messages.
  - name: Phone Numbers
    description: >-
      Your Blujay numbers, whether each can send right now, and their live
      sending limits.
  - name: Capability
    description: >-
      Check whether a phone number can be reached by iMessage, RCS or SMS before
      you send.
  - name: Contacts
    description: Create, find, update, tag, assign and opt out contacts.
  - name: vCards
    description: >-
      Saved contact cards that you can send in a message. Recipients get a
      native contact card over iMessage, SMS or RCS.
  - name: Team Members
    description: People in your workspace you can assign contacts to.
  - name: Workflows
    description: Enroll contacts in workflows you start manually.
  - name: Attachments
    description: >-
      Upload files once and reuse them in messages, or download files from
      messages.
  - name: Webhooks
    description: Subscribe to events, inspect delivery attempts and verify signatures.
paths:
  /v1/webhook-subscriptions/{subscription_id}/events/{event_id}/replay:
    post:
      tags:
        - Webhooks
      summary: Replay a webhook event
      description: >
        Requests that a stored event be sent to this subscription again. The
        event keeps its original `event_id`.


        The subscription must be `active` and still include the event's type, or
        you get `409 WEBHOOK_SUBSCRIPTION_INACTIVE`. If the subscription's
        `phone_number_filter` excludes the number the event belongs to, you get
        `409 WEBHOOK_PHONE_NUMBER_EXCLUDED`.


        Send an `Idempotency-Key` so you can safely retry this call.
      operationId: replayPublicWebhookEvent
      parameters:
        - $ref: '#/components/parameters/WebhookSubscriptionId'
        - $ref: '#/components/parameters/EventId'
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: >-
            This `Idempotency-Key` was already used for the same request. The
            response is the original one.
          headers:
            X-Trace-ID:
              $ref: '#/components/headers/XTraceID'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        $ref: '#/components/schemas/PublicWebhookReplayAccepted'
              examples:
                replayAlreadyAccepted:
                  summary: Repeated request with the same Idempotency-Key
                  value:
                    status: success
                    data:
                      subscription_id: whsub_abc123
                      event_id: evt_abc123
                      status: accepted
                    trace_id: trc_8f2a1c0e4b7d
                    timestamp: '2026-10-14T17:02:00.000Z'
        '202':
          description: The replay request was accepted.
          headers:
            X-Trace-ID:
              $ref: '#/components/headers/XTraceID'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        $ref: '#/components/schemas/PublicWebhookReplayAccepted'
              examples:
                replayAccepted:
                  summary: Replay accepted
                  value:
                    status: success
                    data:
                      subscription_id: whsub_abc123
                      event_id: evt_abc123
                      status: accepted
                    trace_id: trc_8f2a1c0e4b7d
                    timestamp: '2026-10-14T17:02:00.000Z'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >
            The event can't be replayed, or the `Idempotency-Key` conflicts:

            - `WEBHOOK_SUBSCRIPTION_INACTIVE`: the subscription is disabled or
            no longer includes this event type.

            - `WEBHOOK_PHONE_NUMBER_EXCLUDED`: the subscription's
            `phone_number_filter` excludes the event's number.

            - `IDEMPOTENCY_REQUEST_MISMATCH`: the key was already used for a
            different request.

            - `IDEMPOTENCY_IN_PROGRESS`: a request with this key is still
            running. Retry shortly.
          headers:
            X-Trace-ID:
              $ref: '#/components/headers/XTraceID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                subscriptionInactive:
                  value:
                    status: error
                    error:
                      code: WEBHOOK_SUBSCRIPTION_INACTIVE
                      message: Webhook subscription is not active for this event
                      type: validation
                      http_status: 409
                      retryable: false
                      doc_url: >-
                        https://docs.blujay.io/errors/webhook-subscription-inactive
                      details: []
                    trace_id: trc_8f2a1c0e4b7d
                    timestamp: '2026-10-14T17:02:00.000Z'
                phoneNumberExcluded:
                  value:
                    status: error
                    error:
                      code: WEBHOOK_PHONE_NUMBER_EXCLUDED
                      message: >-
                        Webhook subscription does not include this event's phone
                        number
                      type: validation
                      http_status: 409
                      retryable: false
                      doc_url: >-
                        https://docs.blujay.io/errors/webhook-phone-number-excluded
                      details: []
                    trace_id: trc_8f2a1c0e4b7d
                    timestamp: '2026-10-14T17:02:00.000Z'
                idempotencyMismatch:
                  value:
                    status: error
                    error:
                      code: IDEMPOTENCY_REQUEST_MISMATCH
                      message: >-
                        Idempotency key was reused with a different request
                        shape
                      type: idempotency
                      http_status: 409
                      retryable: false
                      doc_url: >-
                        https://docs.blujay.io/errors/idempotency-request-mismatch
                      details: []
                    trace_id: trc_8f2a1c0e4b7d
                    timestamp: '2026-10-14T17:02:00.000Z'
                idempotencyInProgress:
                  value:
                    status: error
                    error:
                      code: IDEMPOTENCY_IN_PROGRESS
                      message: >-
                        An idempotent request with this key is already in
                        progress
                      type: idempotency
                      http_status: 409
                      retryable: true
                      doc_url: https://docs.blujay.io/errors/idempotency-in-progress
                      details: []
                    trace_id: trc_8f2a1c0e4b7d
                    timestamp: '2026-10-14T17:02:00.000Z'
        '503':
          $ref: '#/components/responses/QueueUnavailable'
      security:
        - PublicApiKey: []
components:
  parameters:
    WebhookSubscriptionId:
      name: subscription_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/WebhookSubscriptionId'
    EventId:
      name: event_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/EventId'
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 255
      description: >
        A unique value you choose (1–255 characters) that makes this request
        safe to retry. Send the same key with the same request and Blujay
        returns the original response instead of doing the work again. Use a new
        key for each new action.


        Blujay keeps keys for at least 24 hours. Keys are separate for each API
        key and each route family (for example every `POST
        /v1/chats/{chat_id}/messages` shares one). Reusing a key with a
        different request returns `409 IDEMPOTENCY_REQUEST_MISMATCH`. Sending it
        while the first request is still running returns `409
        IDEMPOTENCY_IN_PROGRESS`; retry shortly.
  headers:
    XTraceID:
      description: >-
        Unique ID for this request. It matches `trace_id` in the body. Include
        it when you contact Blujay support.
      schema:
        $ref: '#/components/schemas/TraceId'
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
  schemas:
    SuccessEnvelope:
      type: object
      description: Wraps every successful response. The result is in `data`.
      required:
        - status
        - trace_id
        - timestamp
      properties:
        status:
          type: string
          enum:
            - success
        trace_id:
          $ref: '#/components/schemas/TraceId'
        timestamp:
          type: string
          examples:
            - '2026-10-14T17:01:00.000Z'
          format: date-time
        client_request_id:
          type: string
          description: >-
            Your `X-Request-ID` header value, echoed back when you send one. Not
            included on the send responses (`POST /v1/chats`, `POST
            /v1/chats/{chat_id}/messages`, `POST
            /v1/messages/{message_id}/retry`); keep your own mapping from your
            request ID to the returned message ID there.
    PublicWebhookReplayAccepted:
      type: object
      additionalProperties: false
      required:
        - subscription_id
        - event_id
        - status
      properties:
        subscription_id:
          $ref: '#/components/schemas/WebhookSubscriptionId'
        event_id:
          $ref: '#/components/schemas/EventId'
        status:
          type: string
          enum:
            - accepted
    ErrorEnvelope:
      type: object
      description: >-
        Wraps every error response. Branch on `error.code`, and include
        `trace_id` when you contact support.
      required:
        - status
        - error
        - trace_id
        - timestamp
      properties:
        status:
          const: error
        error:
          $ref: '#/components/schemas/PublicError'
        trace_id:
          $ref: '#/components/schemas/TraceId'
        timestamp:
          type: string
          examples:
            - '2026-10-14T17:01:00.000Z'
          format: date-time
        client_request_id:
          type: string
          description: Your `X-Request-ID` header value, echoed back when you send one.
    WebhookSubscriptionId:
      type: string
      examples:
        - whsub_abc123
      pattern: ^whsub_[A-Za-z0-9_-]+$
    EventId:
      type: string
      examples:
        - evt_abc123
      pattern: ^evt_[A-Za-z0-9_-]+$
    TraceId:
      type: string
      examples:
        - trc_8f2a1c0e4b7d
      pattern: ^trc_[A-Za-z0-9_-]+$
    PublicError:
      type: object
      required:
        - code
        - message
        - type
        - http_status
        - retryable
        - doc_url
        - details
      properties:
        code:
          type: string
          description: Stable, machine-readable error code. Branch on this value.
          examples:
            - RATE_LIMIT_EXCEEDED
            - QUEUE_UNAVAILABLE
            - FEATURE_NOT_ENABLED
        message:
          type: string
          description: Human-readable explanation. It can change, so don't parse it.
        type:
          type: string
          description: Broad error category.
          examples:
            - validation
            - auth
            - idempotency
            - rate_limit
            - queue
            - feature_gate
        http_status:
          type: integer
          description: The HTTP status code of the response.
          enum:
            - 400
            - 401
            - 403
            - 404
            - 409
            - 413
            - 415
            - 422
            - 429
            - 500
            - 502
            - 503
        retryable:
          type: boolean
          description: Whether sending the same request again later can succeed.
        doc_url:
          type: string
          format: uri
          description: Link to documentation for this error code.
        details:
          type: array
          description: >-
            Extra structured context, such as the fields that failed validation
            or the limit you hit.
          items:
            type: object
            additionalProperties: true
        retry_after:
          type: integer
          minimum: 1
          description: >-
            Seconds to wait before retrying. Also sent as the `Retry-After`
            header.
        reset_at:
          type: string
          examples:
            - '2026-10-14T17:01:00.000Z'
          format: date-time
          description: When the limit you hit resets.
  responses:
    NotFound:
      description: The resource doesn't exist or isn't in your workspace.
      headers:
        X-Trace-ID:
          $ref: '#/components/headers/XTraceID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    QueueUnavailable:
      description: >-
        Blujay can't accept the request right now (`QUEUE_UNAVAILABLE`). Retry
        after `Retry-After` seconds; for sends, reuse the same
        `Idempotency-Key`.
      headers:
        X-Trace-ID:
          $ref: '#/components/headers/XTraceID'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            unavailable:
              value:
                status: error
                error:
                  code: QUEUE_UNAVAILABLE
                  message: Sending is temporarily unavailable
                  type: queue
                  http_status: 503
                  retryable: true
                  doc_url: https://docs.blujay.io/errors/queue-unavailable
                  details: []
                  retry_after: 30
                trace_id: trc_8f2a1c0e4b7d
                timestamp: '2026-10-14T00:00:00.000Z'
  securitySchemes:
    PublicApiKey:
      type: http
      scheme: bearer
      bearerFormat: blu_...
      description: >
        Your workspace API key, sent as `Authorization: Bearer blu_...`.
        Workspace admins can find it in the Blujay app under **API**.


        An API key has full access to your workspace and works on every
        endpoint. There is no test mode: every key sends real messages and
        changes real data, so keep it secret and use it only from your server.


        Each API key can make 600 read requests and 120 write requests per
        minute, plus 60 attachment requests per minute. Over a limit you get
        `429 RATE_LIMIT_EXCEEDED` with `Retry-After`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.