> ## Documentation Index > Fetch the complete documentation index at: https://docs.speedsellx.io/llms.txt > Use this file to discover all available pages before exploring further. # Registrar webhook > Recebe a URL de destino, um `token` de assinatura opcional, um escopo de produto opcional (`null` significa todos os produtos) e um booleano por evento. Responde `201`. Esta é a única escrita que lê `active`, então dá para registrar uma assinatura já muda. Exige o escopo `webhooks:create` e o header `Idempotency-Key`. ## OpenAPI ````yaml /apps/seller/openapi.json post /public/webhooks openapi: 3.1.0 info: title: SpeedSellX API version: 2.0.0 description: >- API pública da SpeedSellX para consultar e atualizar, por integração, os dados da sua conta: produtos, pedidos, reembolsos, chargebacks, checkouts, upsells, webhooks, assinaturas, vendas e métricas. Autentique com `Authorization: Bearer sk_live_...` e gere chaves no painel, em Desenvolvedores. Requisições que alteram dados exigem o header `Idempotency-Key`. Listagens aceitam `page`/`per_page` (padrão 15) e retornam `{ data, links, meta }`. servers: - url: https://api.speedsellx.io/v2 description: Produção security: - bearerAuth: [] tags: - name: Ping description: A chamada que prova que a chave funciona. - name: Pedidos description: Os pedidos da conta da chave. - name: Reembolsos description: Os pedidos de reembolso da conta da chave. - name: Produtos description: >- O catálogo da conta da chave: leitura, criação, substituição, preço e arquivamento. - name: Checkouts description: Os checkouts da conta da chave e a personalização deles. - name: Assinaturas description: As assinaturas recorrentes da conta da chave. - name: Upsells description: As ofertas de upsell da conta da chave. - name: Métricas description: Os agregados da conta da chave. - name: Vendas description: O resumo de vendas pagas por janela de datas. - name: Chargebacks description: Os chargebacks abertos contra a conta da chave. - name: Webhooks description: As assinaturas de webhook da conta da chave. paths: /public/webhooks: post: tags: - Webhooks summary: Registrar webhook description: >- Recebe a URL de destino, um `token` de assinatura opcional, um escopo de produto opcional (`null` significa todos os produtos) e um booleano por evento. Responde `201`. Esta é a única escrita que lê `active`, então dá para registrar uma assinatura já muda. Exige o escopo `webhooks:create` e o header `Idempotency-Key`. operationId: publicapi.webhooks.store parameters: - name: Idempotency-Key in: header required: true description: >- Chave única da operação. Obrigatória em toda requisição que altera dados; sem ela a resposta é `422` `idempotency_key_required`. Um reenvio com a mesma chave e o mesmo corpo repete a resposta guardada. schema: type: string maxLength: 255 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StoreApiWebhookRequest' responses: '201': description: '`ApiWebhookResource`' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ApiWebhookResource' required: - data '401': description: Chave ausente, inválida ou revogada. content: application/json: schema: type: object properties: status: type: string const: error error: type: string const: unauthenticated required: - status - error '403': description: A chave não tem o escopo que a rota exige. content: application/json: schema: type: object properties: status: type: string const: error error: type: string const: insufficient_scope required: - status - error '409': description: >- `idempotency_in_progress` quando já há uma requisição com essa `Idempotency-Key` em andamento; `idempotency_key_reuse` quando a chave voltou com outro corpo. content: application/json: schema: type: object properties: status: type: string const: error error: type: string enum: - idempotency_in_progress - idempotency_key_reuse required: - status - error '422': $ref: '#/components/responses/ValidationException' '429': description: Limite de requisições por minuto excedido para esta chave. components: schemas: StoreApiWebhookRequest: type: object description: >- Body of POST /v2/public/webhooks. Registration is the one write that reads `active`, so a caller can register a subscription muted; afterwards it flips through the toggle endpoint alone. properties: url: type: string format: uri maxLength: 2048 token: type: - string - 'null' maxLength: 255 product_id: type: - integer - 'null' order_payment_approved: type: boolean order_payment_pending: type: boolean order_payment_failed: type: boolean order_payment_refunded: type: boolean order_subscription_approved: type: boolean order_subscription_pending: type: boolean order_subscription_failed: type: boolean order_subscription_refunded: type: boolean order_subscription_canceled: type: boolean order_subscription_trial_started: type: boolean active: type: boolean required: - url title: StoreApiWebhookRequest ApiWebhookResource: type: object properties: id: type: integer user_id: type: integer url: type: string token: type: - string - 'null' product_id: type: - integer - 'null' active: type: boolean order_payment_approved: type: boolean order_payment_pending: type: boolean order_payment_failed: type: boolean order_payment_refunded: type: boolean order_subscription_approved: type: boolean order_subscription_pending: type: boolean order_subscription_failed: type: boolean order_subscription_refunded: type: boolean order_subscription_canceled: type: boolean order_subscription_trial_started: type: boolean created_at: type: - string - 'null' updated_at: type: - string - 'null' required: - id - user_id - url - token - product_id - active - created_at - updated_at - order_payment_approved - order_payment_pending - order_payment_failed - order_payment_refunded - order_subscription_approved - order_subscription_pending - order_subscription_failed - order_subscription_refunded - order_subscription_canceled - order_subscription_trial_started title: ApiWebhookResource responses: ValidationException: description: Validation error content: application/json: schema: type: object properties: message: type: string description: Errors overview. errors: type: object description: A detailed description of each field that failed validation. additionalProperties: type: array items: type: string required: - message - errors securitySchemes: bearerAuth: type: http scheme: bearer description: A chave de API da conta, no formato `sk_{modo}_{prefixo}.{segredo}`. ````