> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Atualizar destino de webhook API > Edite um destino de webhook da Didit: rótulo, URL, estado, versão e eventos. Operações por API, pagas por chamada, sem contratos. Prompt da API de atualização de destino de webhook Copiar o prompt para a área de transferência \

\`Update a Didit webhook destination through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Change a destination's label, url, enabled state, webhook_version, or subscribed_events. Send only the fields you want to change.

Path parameter:
\- destination_uuid — the destination UUID from GET /v3/webhook/destinations/.

Request body (application/json) — all fields optional:
\{
"label": "Updated label",
"url": "https://yourapp.com/webhooks/v2",
"enabled": false,
"webhook_version": "v3",
"subscribed_events": ["status.updated", "data.updated", "transaction.created"]
}

Critical semantics:
\- subscribed_events is replaced wholesale, NOT merged. To add an event, GET the current destination, append to the list, and send the full array back. Sending [] returns 400.
\- url must remain unique among the application's destinations.
\- A uuid in the body is ignored: the path names the destination.
\- webhook_version applies to future deliveries only. Already-queued deliveries use the version that was active when they were enqueued.
\- The signing secret (secret_shared_key) is NOT rotated by PATCH. Console offers a manual rotation flow. For 24 hours after a rotation, every delivery also carries X-Signature-Previous, X-Signature-V2-Previous and X-Signature-Simple-Previous, made with the replaced secret, and previous_secret_expires_at says when that ends.
\- Changing url does not move automatic retries of deliveries already made: they go to the URL the first attempt used. A manual resend goes to the destination's current URL.

Example call (replace subscription list):
curl -X PATCH "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"subscribed_events": ["status.updated", "data.updated", "transaction.created"]}'

\# Pause a destination without losing config:
curl -X PATCH "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"enabled": false}'

Failure modes:
\- 400 — empty subscribed_events, unknown event name, duplicate url among destinations, or invalid webhook_version.
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope.
\- 404 — destination not found in this application.

Side effects:
\- Subsequent webhook deliveries respect the new url, enabled flag, and subscribed_events list.

For the full integration shape, see /integration/integration-prompt.`

\
Colar em Utilize este endpoint para alterar para onde um destino envia webhooks e que eventos recebe.## Atualizar `subscribed_events`Quando enviar `subscribed_events`, indique a lista completa de eventos que devem continuar subscritos após a atualização. O array substitui o conjunto de subscrições anterior.```json theme={null} { "subscribed_events": [ "status.updated", "data.updated", "transaction.created", "transaction.status.updated" ] } ```Os valores suportados são:| Evento | O que representa | | - | - | | `status.updated` | O estado da sessão de Verificação de utilizadores (KYC) ou Verificação de empresas (KYB) foi alterado. | | `data.updated` | Os dados de verificação da sessão foram alterados após a criação. | | `user.status.updated` | O estado da entidade de utilizador foi alterado. | | `user.data.updated` | Os dados da entidade de utilizador foram alterados. | | `business.status.updated` | O estado da entidade empresarial foi alterado. | | `business.data.updated` | Os dados da entidade empresarial foram alterados. | | `activity.created` | Aceite, mas não entregue para tráfego real hoje. | | `transaction.created` | Transação criada e avaliada inicialmente. | | `transaction.status.updated` | O estado da transação foi alterado. | | `travel_rule.status.updated` | O estado de uma troca Travel Rule foi alterado. | | `workflow.compliance_changed` | O estado de conformidade de um fluxo publicado foi alterado. | | `transaction_rule_suggestions.created` | Uma execução de sugestões de regras propôs novas alterações às regras. |As famílias de eventos Investigator (`investigator.*`) e Autenticação (`auth.*`) também são aceites; consulte [Webhooks](https://docs.didit.me/pt/integration/webhooks.md#tipos-de-eventos) para a lista completa.Utilize o [guia de criação de destinos](https://docs.didit.me/pt/management-api/webhook/create-destination.md) para descrições detalhadas dos eventos e conjuntos de subscrição comuns. ## OpenAPI ````yaml pt/openapi-25.json PATCH /v3/webhook/destinations/{destination_uuid}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/webhook/destinations/{destination_uuid}/: patch: tags: - Webhook summary: Atualizar destino do webhook description: >- Atualizar um destino do webhook. **`subscribed_events` é SUBSTITUÍDO na totalidade, não intercalado**: obtenha primeiro, adicione, reenvie. O segredo não é renovado. Um `uuid` no corpo é ignorado: o caminho identifica o destino. operationId: update_webhook_destination parameters: - name: destination_uuid in: path required: true description: UUID do destino a atualizar. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 requestBody: required: true content: application/json: schema: type: object properties: label: type: string description: Novo nome legível por humanos. url: type: string format: uri description: Novo URL de destino. Deve ser único dentro da aplicação. enabled: type: boolean description: >- Defina como `false` para pausar as entregas para este destino sem o eliminar. webhook_version: type: string enum: - v1 - v2 - v3 description: Nova versão do esquema de payload para entregas futuras. subscribed_events: $ref: '#/components/schemas/WebhookSubscribedEvents' examples: Pause destination: value: enabled: false Add transaction events: value: subscribed_events: - status.updated - data.updated - transaction.created - transaction.status.updated Move target URL: value: label: Production session webhooks v2 url: https://api.yourapp.com/webhooks/didit/v2 responses: '200': description: >- Destino do webhook atualizado. O corpo tem a mesma estrutura de `GET /v3/webhook/destinations/{destination_uuid}/`. content: application/json: schema: type: object properties: uuid: type: string format: uuid label: type: string url: type: string format: uri enabled: type: boolean webhook_version: type: string enum: - v1 - v2 - v3 secret_shared_key: type: string secret_last4: type: string description: >- Últimos quatro carateres do segredo de assinatura atual do destino, para que possa distinguir os segredos. Não são suficientes para verificar uma assinatura. previous_secret_expires_at: type: string format: date-time nullable: true description: >- Definido durante 24 horas após o segredo de assinatura do destino ser alterado na Business Console. Até esse momento, cada entrega para o destino também inclui `X-Signature-Previous`, `X-Signature-V2-Previous` e `X-Signature-Simple-Previous`, gerados com o segredo substituído (consulte [Verificação da assinatura](/pt/integration/webhooks#verificação-da-assinatura)). `null` quando não ocorreu qualquer rotação nas últimas 24 horas. subscribed_events: $ref: '#/components/schemas/WebhookSubscribedEvents' created_by_email: type: string nullable: true description: >- E-mail do membro da Business Console que criou o destino. `null` para um destino criado com uma chave de API. created_by_name: type: string nullable: true description: >- Nome do membro da Business Console que criou o destino. `null` para um destino criado com uma chave de API. created_at: type: string format: date-time updated_at: type: string format: date-time health_status: type: string enum: - healthy - degraded - failing description: >- Estado da entrega. `failing`: 3 ou mais eventos consecutivos falharam a primeira tentativa de entrega desde que o destino respondeu com sucesso pela última vez (consulte `failing_streak`). `degraded`: não está a falhar, mas uma tentativa de entrega falhou nas últimas 24 horas e nenhuma tentativa posterior entregou esse evento; uma nova tentativa ou reenvio bem-sucedido limpa este estado. `healthy`: nenhum dos anteriores. Independente de `enabled`. Uma tentativa falhada é aquela respondida com HTTP 400 ou superior, ou que não obteve qualquer resposta. failing_streak: type: integer description: >- Quantos eventos consecutivos falharam a primeira tentativa de entrega desde a última resposta bem-sucedida do destino, nos últimos 30 dias. As novas tentativas não são contabilizadas, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, termina a sequência. `0` quando nenhum evento falhou desde o último sucesso. failing_since: type: string format: date-time nullable: true description: >- Quando foi feita a primeira tentativa falhada da atual `failing_streak`. `null` quando `failing_streak` é `0`. last_success_at: type: string format: date-time nullable: true description: >- Quando o destino respondeu pela última vez a uma entrega com um estado HTTP inferior a 400, nos últimos 30 dias. `null` se não o tiver feito nesse período. environment: type: string enum: - live - sandbox description: Ambiente da aplicação a que pertence o destino. summary: type: object description: >- Métricas de entrega para os últimos `metrics_window_days` (30) dias. `last_delivery_at` é a tentativa mais recente, independentemente de quando foi efetuada. properties: total_deliveries: type: integer failed_deliveries: type: integer error_rate_percentage: type: integer min_response_time_ms: type: integer nullable: true avg_response_time_ms: type: integer nullable: true max_response_time_ms: type: integer nullable: true last_delivery_at: type: string format: date-time nullable: true metrics_window_days: type: integer description: >- Duração em dias do intervalo abrangido pelas outras métricas de resumo. Sempre `30`. examples: Paused: value: uuid: 11111111-2222-3333-4444-555555555555 label: Production session webhooks url: https://yourapp.com/webhooks/didit enabled: false webhook_version: v3 secret_shared_key: tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ secret_last4: 0xnQ previous_secret_expires_at: null subscribed_events: - status.updated - data.updated created_by_email: null created_by_name: null created_at: '2026-01-04T08:00:00Z' updated_at: '2026-05-17T11:02:55Z' health_status: healthy failing_streak: 0 failing_since: null last_success_at: '2026-05-17T09:21:18Z' environment: live summary: total_deliveries: 12453 failed_deliveries: 14 error_rate_percentage: 0 min_response_time_ms: 41 avg_response_time_ms: 187 max_response_time_ms: 2103 last_delivery_at: '2026-05-17T09:21:18Z' metrics_window_days: 30 '400': description: >- Falha na validação (URL duplicado, lista de eventos vazia/com eventos desconhecidos, corpo malformado). content: application/json: examples: Duplicate URL: value: url: - >- This webhook destination already exists for the application. Empty events: value: subscribed_events: - At least one subscribed event is required. '403': description: >- Chave de API em falta, mal formatada, expirada ou com âmbito limitado a uma aplicação diferente. Uma chave em falta devolve `403`; uma chave incorreta, revogada ou expirada devolve `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- O destino com este UUID não existe (ou foi eliminado, ou pertence a outra aplicação). content: application/json: examples: Not found: value: detail: Webhook destination not found. '429': description: Limite de pedidos excedido; reduza a frequência e tente novamente. content: application/json: examples: Throttled: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "subscribed_events": [ "status.updated", "data.updated", "transaction.created" ] }' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.webhooks.destinations.update( "11111111-2222-3333-4444-555555555555", enabled=False, ) print(result) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.webhooks.destinations.update("11111111-2222-3333-4444-555555555555", { enabled: false, }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsUpdateParams{\n\tEnabled: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.WebhooksDestinationsUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.webhooks().destinations().update("11111111-2222-3333-4444-555555555555", WebhooksDestinationsUpdateParams.builder() .enabled(false) .build()); System.out.println(result); - lang: php label: PHP source: >- webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [ 'enabled' => false, ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.webhooks.destinations.update( "11111111-2222-3333-4444-555555555555", enabled: false ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Webhooks.Destinations.UpdateAsync("11111111-2222-3333-4444-555555555555", new WebhooksDestinationsUpdateParams { Enabled = false, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: WebhookSubscribedEvents: type: array description: >- Filtro de eventos para este destino do webhook. O Didit entrega apenas webhooks cujo tipo de evento corresponda exatamente a um destes valores — não existe subscrição com carateres universais. Ao ser enviada, a lista deve conter pelo menos um evento válido (um `[]` explícito é rejeitado com 400); um destino cuja lista esteja vazia (campo omitido na criação) não recebe nada. Na atualização, a lista é substituída integralmente, nunca fundida. minItems: 1 uniqueItems: true items: $ref: '#/components/schemas/WebhookEvent' example: - status.updated - data.updated WebhookEvent: type: string description: >- Nome de evento de webhook suportado. Utilize estas strings exatas em `subscribed_events`; valores não suportados são rejeitados. enum: - status.updated - data.updated - user.status.updated - user.data.updated - business.status.updated - business.data.updated - activity.created - transaction.created - transaction.status.updated - travel_rule.status.updated - workflow.compliance_changed - transaction_rule_suggestions.created - auth.signup - auth.login - auth.login_failed - auth.password_reset_requested - auth.password_reset_completed - auth.mfa_changed - auth.new_device - auth.account_locked - investigator.report.ready - investigator.decision.automated - investigator.decision.overridden - investigator.decision.contested - investigator.question.raised - investigator.automation.paused - investigator.rfi.answered - investigator.rfi.overdue - investigator.drift.detected - investigator.sla.breached - investigator.qa.failed - investigator.external.report.ready securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.