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

# Atualizar webhook

> Altera só os campos enviados. `status` aceita `enabled` ou `disabled` (`paused` só o PostClean define). Ativar um webhook desativado ou pausado zera `consecutive_failures` e `paused_at`. Um novo endpoint que não seja uma URL pública `http` ou `https` retorna `422` em `endpoint`. O segredo de assinatura não vem na resposta.



## OpenAPI

````yaml /openapi.json put /webhooks/{webhook}
openapi: 3.1.0
info:
  title: PostClean API
  version: 2.0.0
  description: >-
    API REST do PostClean. Autentique com uma chave de API do workspace, enviada
    como token Bearer no cabeçalho `Authorization`.
servers:
  - url: https://post.chatclean.com.br/api
    description: PostClean
security:
  - bearerAuth: []
tags:
  - name: Posts
    description: Criar, ler, atualizar, excluir e pré-visualizar posts.
  - name: Post notes
    description: Notas internas de um post, visíveis aos membros do workspace.
  - name: Approvals
    description: Aprovar ou rejeitar posts que aguardam aprovação.
  - name: Recurrence
    description: Fazer um post se repetir numa frequência.
  - name: Media and uploads
    description: Enviar arquivos e anexar mídia aos posts.
  - name: Social accounts
    description: Contas sociais conectadas e as opções de cada rede.
  - name: Channels
    description: Horários de postagem e fila de um canal.
  - name: Ideas
    description: Ideias do quadro Criar.
  - name: Idea stages
    description: As colunas (etapas) do quadro de ideias.
  - name: Analytics
    description: Métricas do workspace e dos canais.
  - name: Labels
    description: Etiquetas para organizar posts e ideias.
  - name: Signatures
    description: Textos reutilizáveis para adicionar aos posts.
  - name: Workspace
    description: O workspace ao qual a chave de API pertence.
  - name: API keys
    description: Chaves de API pessoais deste workspace.
  - name: Webhooks
    description: Webhooks de saída e os registros de entrega.
  - name: Repurposes
    description: Automações que republicam vídeos postados fora do PostClean.
  - name: Platform
    description: Recursos de cada plataforma e tipos de conteúdo.
paths:
  /webhooks/{webhook}:
    parameters:
      - $ref: '#/components/parameters/WebhookId'
    put:
      tags:
        - Webhooks
      summary: Atualizar webhook
      description: >-
        Altera só os campos enviados. `status` aceita `enabled` ou `disabled`
        (`paused` só o PostClean define). Ativar um webhook desativado ou
        pausado zera `consecutive_failures` e `paused_at`. Um novo endpoint que
        não seja uma URL pública `http` ou `https` retorna `422` em `endpoint`.
        O segredo de assinatura não vem na resposta.
      operationId: updateWebhook
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                endpoint:
                  type: string
                  format: uri
                  maxLength: 255
                events:
                  type: array
                  minItems: 1
                  items:
                    $ref: '#/components/schemas/WebhookEventType'
                status:
                  type: string
                  enum:
                    - enabled
                    - disabled
            example:
              events:
                - post.created
                - post.scheduled
                - post.unscheduled
                - post.published
                - post.partially_published
                - post.failed
                - post.deleted
              status: enabled
      responses:
        '200':
          description: O webhook atualizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
              example:
                id: 9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e
                endpoint: https://example.com/hooks/postclean
                events:
                  - post.created
                  - post.scheduled
                  - post.unscheduled
                  - post.published
                  - post.partially_published
                  - post.failed
                  - post.deleted
                status: enabled
                last_sent_at: '2026-10-08T14:00:03+00:00'
                paused_at: null
                consecutive_failures: 0
                created_at: '2026-09-15T10:00:00+00:00'
                updated_at: '2026-10-08T15:00:00+00:00'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    WebhookId:
      name: webhook
      in: path
      required: true
      description: Id do webhook. Um webhook de outro workspace devolve `404`.
      schema:
        type: string
        format: uuid
      example: 9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e
  schemas:
    WebhookEventType:
      type: string
      enum:
        - post.created
        - post.scheduled
        - post.unscheduled
        - post.published
        - post.partially_published
        - post.failed
        - post.deleted
      description: >-
        - `post.created`: um post foi criado. O `data.status` é o status com que
        ele foi criado (`draft`, `scheduled`, `publishing` ou
        `pending_approval`).

        - `post.scheduled`: um post existente foi agendado (por exemplo, um
        rascunho agendado ou uma solicitação aprovada). Um post criado já
        agendado envia só `post.created`.

        - `post.unscheduled`: um post agendado voltou para rascunho ou para
        aguardando aprovação.

        - `post.published`: o post foi publicado em todos os canais.

        - `post.partially_published`: o post foi publicado em alguns canais e
        falhou em outros.

        - `post.failed`: a publicação falhou.

        - `post.deleted`: um post foi excluído. Não é enviado para posts
        importados da rede nem para posts removidos ao desconectar o canal
        deles. O `data` é só `{id, workspace_id}`.
    Webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
        endpoint:
          type: string
          format: uri
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        status:
          type: string
          enum:
            - enabled
            - disabled
            - paused
          description: >-
            O PostClean define `paused` depois de 5 entregas seguidas com falha
            (o dono da conta recebe um e-mail). Envie `status: enabled` para
            retomar.
        last_sent_at:
          type:
            - string
            - 'null'
          format: date-time
          description: ISO 8601, em UTC.
          examples:
            - '2026-10-08T14:00:03+00:00'
        paused_at:
          type:
            - string
            - 'null'
          format: date-time
          description: ISO 8601, em UTC.
        consecutive_failures:
          type: integer
        signing_secret:
          type: string
          description: >-
            Segredo usado para assinar as entregas (`whsec_` seguido de 32
            caracteres). Só vem ao criar, obter ou trocar o segredo do webhook.
          examples:
            - whsec_4qXbV8kP2mT7nR1sW9yZ3cE6hJ0aL5dF
        created_at:
          type: string
          format: date-time
          description: ISO 8601, em UTC.
          examples:
            - '2026-09-15T10:00:00+00:00'
        updated_at:
          type: string
          format: date-time
          description: ISO 8601, em UTC.
          examples:
            - '2026-10-08T14:00:03+00:00'
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    ValidationErrorBody:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      description: Corpo de erro de validação. `errors` traz as mensagens por campo.
    RateLimitErrorBody:
      type: object
      properties:
        name:
          type: string
          const: rate_limit_exceeded
        message:
          type: string
          examples:
            - Rate limit exceeded. Please retry after 30 seconds.
      description: Corpo devolvido quando o limite de requisições é excedido.
  responses:
    Unauthorized:
      description: >-
        Chave de API ausente, inválida, revogada ou expirada. Corpos possíveis:
        `Unauthenticated.` (sem chave, ou chave inválida ou revogada), `Token
        expired.` (passou do `expires_at`), `Token not found.` e `No workspace
        selected.` (a chave não está mais ligada a um workspace).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Unauthenticated.
    PaymentRequired:
      description: >-
        A conta do workspace não tem assinatura ativa nem período de teste.
        Corpo: `{"message": "Active subscription required."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Active subscription required.
    Forbidden:
      description: >-
        A requisição não é permitida. Chaves de API só funcionam para
        administradores do workspace (o dono da conta ou um membro marcado como
        administrador); fora isso, toda requisição devolve `Insufficient
        workspace permissions.`. Outros corpos: `Workspace access denied.` (o
        usuário da chave saiu do workspace), `Personal access token required.`
        (foi enviado um token OAuth do MCP) e `This action is unauthorized.`
        (por exemplo, a nota pertence a outro membro).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    NotFound:
      description: O recurso não existe neste workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    ValidationError:
      description: A validação falhou. Cada campo com erro aparece em `errors`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorBody'
    TooManyRequests:
      description: 'Limite de requisições excedido: 60 por minuto por workspace.'
      headers:
        Retry-After:
          description: Segundos de espera antes de tentar de novo.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorBody'
          example:
            name: rate_limit_exceeded
            message: Rate limit exceeded. Please retry after 30 seconds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API do workspace, criada em Configurações > Chaves de API.

````

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