{ "error": "An API key can own at most 5 webhooks"}
Regista um URL HTTPS que recebe eventos de webhook. A tua chave de API é a proprietária do
webhook. Este recebe um evento apenas para objetos que a tua chave consegue ler. Uma chave de API pode ter no máximo 5
webhooks.
Requer o âmbito webhooks_manage.
Pedido
Parâmetros do corpo
string
obrigatório
URL HTTPS na porta 443 com um host público e sem credenciais. A Aniva não segue redirecionamentos.
string[]
obrigatório
Tipos de eventos a receber, pelo menos um. ["*"] significa todos os tipos.
ping não pode ser listado.
string[]
obrigatório
1 a 5 endereços para os quais a Aniva envia email quando as entregas continuam a falhar.
string
Texto livre para a tua própria referência, no máximo 500 caracteres.
Resposta
Em caso de sucesso, a API devolve 201 Created com o webhook e o seu segredo.
string
obrigatório
O segredo de assinatura, whsec_ seguido de base64. A Aniva mostra-o apenas nesta resposta. Consulta Verificar a
assinatura.
string
obrigatório
Identificador do webhook (UUID).
string
obrigatório
O URL HTTPS para o qual a Aniva envia os eventos.
string
Texto livre para a tua própria referência. Pode ser null.
string[]
obrigatório
Tipos de eventos que este webhook recebe. * significa todos os tipos.
string[]
obrigatório
Endereços para os quais a Aniva envia email quando as entregas continuam a falhar.
string
obrigatório
enabled ou disabled.
string
Instante ISO 8601 UTC em que o webhook foi desativado. null enquanto estiver ativo.
string
Motivo pelo qual o webhook foi desativado. Consulta Avisos de falha. null
enquanto estiver ativo.
string
Instante ISO 8601 UTC em que começou a sequência atual de falhas. null quando a última entrega teve sucesso.
string
Instante ISO 8601 UTC em que o segredo anterior deixa de assinar. null quando não há rotação em curso.
string
obrigatório
Instante ISO 8601 UTC em que o webhook foi criado.
string
obrigatório
Instante ISO 8601 UTC da última alteração.
Respostas de erro
Estado
Descrição
400
Pedido inválido, por exemplo um URL incorreto, um tipo de evento desconhecido, alert_emails inválidos ou uma chave de API que não pode ter um webhook.
401
Chave de API inválida.
403
Sem chave de API, ou uma chave de API sem o âmbito webhooks_manage.
{ "error": "An API key can own at most 5 webhooks"}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Aniva API","description":"REST API for lab testing in Germany and the EU: book blood draws at pharmacies and practices, ship home test kits, and get lab results.","colors":{"primary":"#e76c2b","light":"#e76c2b","dark":"#e76c2b"},"logo":{"light":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.svg?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=07e4ee4fd57b9ccbe6809fe000f33fdd","dark":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.svg?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=07e4ee4fd57b9ccbe6809fe000f33fdd"},"favicon":{"light":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.png?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=37c01b349855726e2009a8d5aca4487b","dark":"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.png?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=37c01b349855726e2009a8d5aca4487b"},"api":{"openapi":"https://anivahealth.com/api/v1/openapi.json","mdx":{"auth":{"method":"key","name":"x-api-key"}}},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"/status","label":"Status"}]},"footer":{"links":[{"items":[{"label":"Aniva Diagnostics","href":"https://anivahealth.com/diagnostics"},{"label":"hello@anivahealth.com","href":"mailto:hello@anivahealth.com"}]}]},"seo":{"metatags":{"og:locale":"en_US","og:site_name":"Aniva Partner API","keywords":"blood test API, lab testing API, home test kit API, lab results API, biomarker API, pharmacy blood test, Germany, EU"},"indexing":"navigable"},"fonts":{"heading":{"family":"Switzer","weight":600,"source":"https://anivahealth.com/fonts/Switzer-Variable.woff2","format":"woff2"},"body":{"family":"Switzer","source":"https://anivahealth.com/fonts/Switzer-Variable.woff2","format":"woff2"}},"styling":{"latex":false},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"navigation":{"languages":[{"language":"en","href":""},{"language":"de","navbar":{"links":[{"href":"/de/changelog","label":"Changelog"},{"href":"/de/status","label":"Status"}]},"href":"de"},{"language":"ca","navbar":{"links":[{"href":"/ca/changelog","label":"Registre de canvis"},{"href":"/ca/status","label":"Estat"}]},"href":"ca"},{"language":"cs","navbar":{"links":[{"href":"/cs/changelog","label":"Seznam změn"},{"href":"/cs/status","label":"Stav"}]},"href":"cs"},{"language":"da","navbar":{"links":[{"href":"/da/changelog","label":"Ændringslog"},{"href":"/da/status","label":"Status"}]},"href":"da"},{"language":"es","navbar":{"links":[{"href":"/es/changelog","label":"Registro de cambios"},{"href":"/es/status","label":"Estado"}]},"href":"es"},{"language":"fi","navbar":{"links":[{"href":"/fi/changelog","label":"Muutosloki"},{"href":"/fi/status","label":"Tila"}]},"href":"fi"},{"language":"fr","navbar":{"links":[{"href":"/fr/changelog","label":"Journal des modifications"},{"href":"/fr/status","label":"Statut"}]},"href":"fr"},{"language":"hu","navbar":{"links":[{"href":"/hu/changelog","label":"Változásnapló"},{"href":"/hu/status","label":"Állapot"}]},"href":"hu"},{"language":"it","navbar":{"links":[{"href":"/it/changelog","label":"Changelog"},{"href":"/it/status","label":"Stato"}]},"href":"it"},{"language":"lv","navbar":{"links":[{"href":"/lv/changelog","label":"Izmaiņu žurnāls"},{"href":"/lv/status","label":"Statuss"}]},"href":"lv"},{"language":"nl","navbar":{"links":[{"href":"/nl/changelog","label":"Changelog"},{"href":"/nl/status","label":"Status"}]},"href":"nl"},{"language":"no","navbar":{"links":[{"href":"/no/changelog","label":"Endringslogg"},{"href":"/no/status","label":"Status"}]},"href":"no"},{"language":"pl","navbar":{"links":[{"href":"/pl/changelog","label":"Dziennik zmian"},{"href":"/pl/status","label":"Status"}]},"href":"pl"},{"language":"pt","navbar":{"links":[{"href":"/pt/changelog","label":"Registo de alterações"},{"href":"/pt/status","label":"Estado"}]},"href":"pt"},{"language":"ro","navbar":{"links":[{"href":"/ro/changelog","label":"Jurnal de modificări"},{"href":"/ro/status","label":"Stare"}]},"href":"ro"},{"language":"ru","navbar":{"links":[{"href":"/ru/changelog","label":"История изменений"},{"href":"/ru/status","label":"Статус"}]},"href":"ru"},{"language":"sv","navbar":{"links":[{"href":"/sv/changelog","label":"Ändringslogg"},{"href":"/sv/status","label":"Status"}]},"href":"sv"},{"language":"tr","navbar":{"links":[{"href":"/tr/changelog","label":"Değişiklik günlüğü"},{"href":"/tr/status","label":"Durum"}]},"href":"tr"},{"language":"uk","navbar":{"links":[{"href":"/uk/changelog","label":"Історія змін"},{"href":"/uk/status","label":"Статус"}]},"href":"uk"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"anivahealth","hasAudioNarration":false,"actualSubdomain":"anivahealth","customDomains":["docs.anivahealth.com"],"gitSource":{"type":"github","owner":"anivahealth","repo":"web","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b0344de3ca2a55c0067aa73","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"en","tag":"API Reference","count":61},{"language":"ca","tag":"Referència de l'API","count":61},{"language":"cs","tag":"Reference API","count":61},{"language":"da","tag":"API-reference","count":61},{"language":"de","tag":"API-Referenz","count":61},{"language":"es","tag":"Referencia de la API","count":61},{"language":"fi","tag":"API-viite","count":61},{"language":"fr","tag":"Référence API","count":61},{"language":"hu","tag":"API-referencia","count":61},{"language":"it","tag":"Riferimento API","count":61},{"language":"lv","tag":"API uzziņa","count":61},{"language":"nl","tag":"API-referentie","count":61},{"language":"no","tag":"API-referanse","count":61},{"language":"pl","tag":"Dokumentacja API","count":61},{"language":"pt","tag":"Referência da API","count":61},{"language":"ro","tag":"Referință API","count":61},{"language":"ru","tag":"Справочник API","count":61},{"language":"sv","tag":"API-referens","count":61},{"language":"tr","tag":"API referansı","count":61},{"language":"uk","tag":"Довідник API","count":61},{"language":"en","tag":"Documentation","count":18},{"language":"ca","tag":"Documentació","count":18},{"language":"cs","tag":"Dokumentace","count":18},{"language":"da","tag":"Dokumentation","count":18},{"language":"de","tag":"Dokumentation","count":18},{"language":"es","tag":"Documentación","count":18},{"language":"fi","tag":"Dokumentaatio","count":18},{"language":"fr","tag":"Documentation","count":18},{"language":"hu","tag":"Dokumentáció","count":18},{"language":"it","tag":"Documentazione","count":18},{"language":"lv","tag":"Dokumentācija","count":18},{"language":"nl","tag":"Documentatie","count":18},{"language":"no","tag":"Dokumentasjon","count":18},{"language":"pl","tag":"Dokumentacja","count":18},{"language":"pt","tag":"Documentação","count":18},{"language":"ro","tag":"Documentație","count":18},{"language":"ru","tag":"Документация","count":18},{"language":"sv","tag":"Dokumentation","count":18},{"language":"tr","tag":"Dokümantasyon","count":18},{"language":"uk","tag":"Документація","count":18},{"language":"en","tag":"Appointments","count":13},{"language":"ca","tag":"Cites","count":13},{"language":"cs","tag":"Termíny","count":13},{"language":"da","tag":"Tider","count":13},{"language":"de","tag":"Termine","count":13},{"language":"es","tag":"Citas","count":13},{"language":"fi","tag":"Ajanvaraukset","count":13},{"language":"fr","tag":"Rendez-vous","count":13},{"language":"hu","tag":"Időpontok","count":13},{"language":"it","tag":"Appuntamenti","count":13},{"language":"lv","tag":"Pieraksti","count":13},{"language":"nl","tag":"Afspraken","count":13},{"language":"no","tag":"Timer","count":13},{"language":"pl","tag":"Wizyty","count":13},{"language":"pt","tag":"Marcações","count":13},{"language":"ro","tag":"Programări","count":13},{"language":"ru","tag":"Записи","count":13},{"language":"sv","tag":"Bokningar","count":13},{"language":"tr","tag":"Randevular","count":13},{"language":"uk","tag":"Записи","count":13},{"language":"en","tag":"Home Kit Orders","count":10},{"language":"ca","tag":"Comandes de kits de prova a casa","count":10},{"language":"cs","tag":"Objednávky domácích testovacích sad","count":10},{"language":"da","tag":"Ordrer på hjemmetestkit","count":10},{"language":"de","tag":"Heimtest-Kit-Bestellungen","count":10},{"language":"es","tag":"Pedidos de kits de prueba en casa","count":10},{"language":"fi","tag":"Kotitestipakkausten tilaukset","count":10},{"language":"fr","tag":"Commandes de kits à domicile","count":10},{"language":"hu","tag":"Otthoni tesztkészlet-rendelések","count":10},{"language":"it","tag":"Ordini di kit domiciliari","count":10},{"language":"lv","tag":"Mājas testa komplektu pasūtījumi","count":10},{"language":"nl","tag":"Thuistestkitbestellingen","count":10},{"language":"no","tag":"Bestillinger av hjemmetestsett","count":10},{"language":"pl","tag":"Zamówienia domowych zestawów testowych","count":10},{"language":"pt","tag":"Encomendas de kits de teste em casa","count":10},{"language":"ro","tag":"Comenzi de kituri de testare la domiciliu","count":10},{"language":"ru","tag":"Заказы наборов для домашнего теста","count":10},{"language":"sv","tag":"Beställningar av hemtestkit","count":10},{"language":"tr","tag":"Evde test kiti siparişleri","count":10},{"language":"uk","tag":"Замовлення наборів для домашнього тесту","count":10},{"language":"en","tag":"Webhooks","count":9},{"language":"en","tag":"Core Concepts","count":9},{"language":"ca","tag":"Webhooks","count":9},{"language":"ca","tag":"Conceptes clau","count":9},{"language":"cs","tag":"Webhooky","count":9},{"language":"cs","tag":"Základní koncepty","count":9},{"language":"da","tag":"Webhooks","count":9},{"language":"da","tag":"Kernebegreber","count":9},{"language":"de","tag":"Webhooks","count":9},{"language":"de","tag":"Grundkonzepte","count":9},{"language":"es","tag":"Webhooks","count":9},{"language":"es","tag":"Conceptos clave","count":9},{"language":"fi","tag":"Webhookit","count":9},{"language":"fi","tag":"Peruskäsitteet","count":9},{"language":"fr","tag":"Webhooks","count":9},{"language":"fr","tag":"Concepts clés","count":9},{"language":"hu","tag":"Webhookok","count":9},{"language":"hu","tag":"Alapfogalmak","count":9},{"language":"it","tag":"Webhook","count":9},{"language":"it","tag":"Concetti di base","count":9},{"language":"lv","tag":"Tīmekļa aizķeres","count":9},{"language":"lv","tag":"Pamatjēdzieni","count":9},{"language":"nl","tag":"Webhooks","count":9},{"language":"nl","tag":"Kernconcepten","count":9},{"language":"no","tag":"Webhooks","count":9},{"language":"no","tag":"Kjernekonsepter","count":9},{"language":"pl","tag":"Webhooki","count":9},{"language":"pl","tag":"Podstawowe pojęcia","count":9},{"language":"pt","tag":"Webhooks","count":9},{"language":"pt","tag":"Conceitos principais","count":9},{"language":"ro","tag":"Webhook-uri","count":9},{"language":"ro","tag":"Concepte de bază","count":9},{"language":"ru","tag":"Вебхуки","count":9},{"language":"ru","tag":"Основные понятия","count":9},{"language":"sv","tag":"Webhooks","count":9},{"language":"sv","tag":"Grundkoncept","count":9},{"language":"tr","tag":"Webhook'lar","count":9},{"language":"tr","tag":"Temel kavramlar","count":9},{"language":"uk","tag":"Вебхуки","count":9},{"language":"uk","tag":"Основні поняття","count":9},{"language":"en","tag":"Shipments","count":8},{"language":"ca","tag":"Enviaments","count":8},{"language":"cs","tag":"Zásilky","count":8},{"language":"da","tag":"Forsendelser","count":8},{"language":"de","tag":"Sendungen","count":8},{"language":"es","tag":"Envíos","count":8},{"language":"fi","tag":"Lähetykset","count":8},{"language":"fr","tag":"Expéditions","count":8},{"language":"hu","tag":"Szállítmányok","count":8},{"language":"it","tag":"Spedizioni","count":8},{"language":"lv","tag":"Sūtījumi","count":8},{"language":"nl","tag":"Zendingen","count":8},{"language":"no","tag":"Forsendelser","count":8},{"language":"pl","tag":"Przesyłki","count":8},{"language":"pt","tag":"Envios","count":8},{"language":"ro","tag":"Expedieri","count":8},{"language":"ru","tag":"Отправления","count":8},{"language":"sv","tag":"Försändelser","count":8},{"language":"tr","tag":"Gönderiler","count":8},{"language":"uk","tag":"Відправлення","count":8},{"language":"en","tag":"Get Started","count":6},{"language":"ca","tag":"Primers passos","count":6},{"language":"cs","tag":"Začínáme","count":6},{"language":"da","tag":"Kom i gang","count":6},{"language":"de","tag":"Erste Schritte","count":6},{"language":"es","tag":"Primeros pasos","count":6},{"language":"fi","tag":"Aloitus","count":6},{"language":"fr","tag":"Démarrer","count":6},{"language":"hu","tag":"Első lépések","count":6},{"language":"it","tag":"Per iniziare","count":6},{"language":"lv","tag":"Sākt darbu","count":6},{"language":"nl","tag":"Aan de slag","count":6},{"language":"no","tag":"Kom i gang","count":6},{"language":"pl","tag":"Pierwsze kroki","count":6},{"language":"pt","tag":"Começar","count":6},{"language":"ro","tag":"Primii pași","count":6},{"language":"ru","tag":"Начало работы","count":6},{"language":"sv","tag":"Kom igång","count":6},{"language":"tr","tag":"Başlangıç","count":6},{"language":"uk","tag":"Початок роботи","count":6},{"language":"en","tag":"Locations","count":5},{"language":"en","tag":"Profiles","count":5},{"language":"ca","tag":"Ubicacions","count":5},{"language":"ca","tag":"Perfils","count":5},{"language":"cs","tag":"Lokality","count":5},{"language":"cs","tag":"Profily","count":5},{"language":"da","tag":"Lokationer","count":5},{"language":"da","tag":"Profiler","count":5},{"language":"de","tag":"Standorte","count":5},{"language":"de","tag":"Profile","count":5},{"language":"es","tag":"Ubicaciones","count":5},{"language":"es","tag":"Perfiles","count":5},{"language":"fi","tag":"Toimipisteet","count":5},{"language":"fi","tag":"Profiilit","count":5},{"language":"fr","tag":"Lieux","count":5},{"language":"fr","tag":"Profils","count":5},{"language":"hu","tag":"Helyszínek","count":5},{"language":"hu","tag":"Profilok","count":5},{"language":"it","tag":"Sedi","count":5},{"language":"it","tag":"Profili","count":5},{"language":"lv","tag":"Atrašanās vietas","count":5},{"language":"lv","tag":"Profili","count":5},{"language":"nl","tag":"Locaties","count":5},{"language":"nl","tag":"Profielen","count":5},{"language":"no","tag":"Steder","count":5},{"language":"no","tag":"Profiler","count":5},{"language":"pl","tag":"Lokalizacje","count":5},{"language":"pl","tag":"Profile","count":5},{"language":"pt","tag":"Locais","count":5},{"language":"pt","tag":"Perfis","count":5},{"language":"ro","tag":"Locații","count":5},{"language":"ro","tag":"Profiluri","count":5},{"language":"ru","tag":"Локации","count":5},{"language":"ru","tag":"Профили","count":5},{"language":"sv","tag":"Platser","count":5},{"language":"sv","tag":"Profiler","count":5},{"language":"tr","tag":"Konumlar","count":5},{"language":"tr","tag":"Profiller","count":5},{"language":"uk","tag":"Локації","count":5},{"language":"uk","tag":"Профілі","count":5}],"searchSettings":{"showContentSnippets":true,"maxResults":8}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"update-label\"]{background:transparent;color:rgb(107 114 128);padding-left:0.25rem;padding-right:0;font-weight:400}.dark [data-component-part=\"update-label\"]{color:rgb(156 163 175)}[data-component-part=\"update-tag-list\"]{margin-top:0.25rem;column-gap:0.25rem}[data-component-part=\"update-tag\"]:not(:last-child)::after{content:'·';margin-left:0.25rem}@media (max-width: 1023px){.update-container>div:first-child{flex-direction:row;flex-wrap:wrap;align-items:center;column-gap:0.75rem}.update-container [data-component-part=\"update-tag-list\"]{margin-top:0}}@media (min-width: 640px){[data-component-part=\"update-content\"] img{max-width:85%}}[data-component-part=\"update-content\"] video{cursor:zoom-in}.video-zoom{position:fixed;inset:0;z-index:100;display:flex;align-items:center;justify-content:center;padding:2rem;background:rgb(255 255 255 / 0.9);cursor:zoom-out}.dark .video-zoom{background:rgb(0 0 0 / 0.9)}.video-zoom video{width:100%;max-height:100%;object-fit:contain}.video-zoom-close{position:absolute;top:calc(0.75rem + env(safe-area-inset-top, 0px));right:0.75rem;display:inline-flex;align-items:center;justify-content:center;width:2.25rem;height:2.25rem;border:1px solid rgb(0 0 0 / 0.2);border-radius:9999px;background:rgb(255 255 255 / 0.55);color:rgb(23 23 23);box-shadow:0 0.5px 1px rgb(0 0 0 / 0.12),\n 0 1px 2px rgb(0 0 0 / 0.08),\n inset 0 0.5px 0 rgb(255 255 255 / 0.65);backdrop-filter:blur(40px) saturate(1.5);cursor:pointer}.video-zoom-close:focus{outline:none}.video-zoom-close:focus-visible{outline:2px solid rgb(0 0 0 / 0.25)}.dark .video-zoom-close{border-color:rgb(255 255 255 / 0.25);background:rgb(23 23 23 / 0.45);color:white;box-shadow:0 0 0 0.5px #000,\n 0 0.5px 1px rgb(0 0 0 / 0.45),\n 0 1px 2px rgb(0 0 0 / 0.35),\n inset 0 0.5px 0 rgb(255 255 255 / 0.14)}[data-component-part=\"update-content\"] h2>.absolute{display:none}#content{margin-bottom:2rem}[data-assistant-bar].invisible{display:none}#footer>div{flex-direction:row;flex-wrap:wrap;align-items:center;gap:1rem 2rem;padding-top:5rem;padding-bottom:3rem}#footer>div>div:first-child{flex:1;flex-direction:row;align-items:center;min-height:0}#footer>div>div:first-child>div:last-child{display:flex;justify-content:flex-end}#footer>div>div:first-child>div:last-child>div{align-items:flex-end}#footer>div>div:first-child>div:last-child>div>div{flex-direction:row;gap:1.5rem}#footer>div>div:first-child a{max-width:none}#footer>div>.h-px{display:none}#footer>div>div:last-child{gap:1.5rem}"}]}
{"page":{"pagePath":"pt/api/webhooks/create-webhook","slug":"/pt/api/webhooks/create-webhook","pageMetadata":{"title":"Criar webhook","description":"Registar um URL que recebe eventos de webhook","api":"POST https://anivahealth.com/api/v1/webhooks","href":"/pt/api/webhooks/create-webhook"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Registar um URL que recebe eventos de webhook\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,ParamField,ResponseField,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Regista um URL HTTPS que recebe `,_jsx(_components.a,{href:`/pt/concepts/webhooks`,children:`eventos de webhook`}),`. A tua chave de API é a proprietária do\nwebhook. Este recebe um evento apenas para objetos que a tua chave consegue ler. Uma chave de API pode ter no máximo 5\nwebhooks.`]}),`\n`,_jsxs(Note,{children:[`Requer o âmbito `,_jsx(_components.code,{children:`webhooks_manage`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`pedido`,children:`Pedido`}),`\n`,_jsx(Heading,{level:`3`,id:`parâmetros-do-corpo`,children:`Parâmetros do corpo`}),`\n`,_jsx(ParamField,{body:`url`,type:`string`,required:true,id:`param-url`,children:_jsx(_components.p,{children:`URL HTTPS na porta 443 com um host público e sem credenciais. A Aniva não segue redirecionamentos.`})}),`\n`,_jsx(ParamField,{body:`enabled_events`,type:`string[]`,required:true,id:`param-enabled-events`,children:_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/pt/concepts/webhooks#eventos`,children:`Tipos de eventos`}),` a receber, pelo menos um. `,_jsx(_components.code,{children:`[\"*\"]`}),` significa todos os tipos.\n`,_jsx(_components.code,{children:`ping`}),` não pode ser listado.`]})}),`\n`,_jsx(ParamField,{body:`alert_emails`,type:`string[]`,required:true,id:`param-alert-emails`,children:_jsx(_components.p,{children:`1 a 5 endereços para os quais a Aniva envia email quando as entregas continuam a falhar.`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Texto livre para a tua própria referência, no máximo 500 caracteres.`})}),`\n`,_jsx(Heading,{level:`2`,id:`resposta`,children:`Resposta`}),`\n`,_jsxs(_components.p,{children:[`Em caso de sucesso, a API devolve `,_jsx(_components.code,{children:`201 Created`}),` com o webhook e o seu segredo.`]}),`\n`,_jsx(ResponseField,{name:`secret`,type:`string`,required:true,id:`param-secret`,children:_jsxs(_components.p,{children:[`O segredo de assinatura, `,_jsx(_components.code,{children:`whsec_`}),` seguido de base64. A Aniva mostra-o apenas nesta resposta. Consulta `,_jsx(_components.a,{href:`/pt/concepts/webhooks#verificar-a-assinatura`,children:`Verificar a\nassinatura`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Identificador do webhook (UUID).`})}),`\n`,_jsx(ResponseField,{name:`url`,type:`string`,required:true,id:`param-url-1`,children:_jsx(_components.p,{children:`O URL HTTPS para o qual a Aniva envia os eventos.`})}),`\n`,_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-1`,children:_jsxs(_components.p,{children:[`Texto livre para a tua própria referência. Pode ser `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`enabled_events`,type:`string[]`,required:true,id:`param-enabled-events-1`,children:_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/pt/concepts/webhooks#eventos`,children:`Tipos de eventos`}),` que este webhook recebe. `,_jsx(_components.code,{children:`*`}),` significa todos os tipos.`]})}),`\n`,_jsx(ResponseField,{name:`alert_emails`,type:`string[]`,required:true,id:`param-alert-emails-1`,children:_jsx(_components.p,{children:`Endereços para os quais a Aniva envia email quando as entregas continuam a falhar.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`enabled`}),` ou `,_jsx(_components.code,{children:`disabled`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`disabled_at`,type:`string`,id:`param-disabled-at`,children:_jsxs(_components.p,{children:[`Instante ISO 8601 UTC em que o webhook foi desativado. `,_jsx(_components.code,{children:`null`}),` enquanto estiver ativo.`]})}),`\n`,_jsx(ResponseField,{name:`disabled_reason`,type:`string`,id:`param-disabled-reason`,children:_jsxs(_components.p,{children:[`Motivo pelo qual o webhook foi desativado. Consulta `,_jsx(_components.a,{href:`/pt/concepts/webhooks#avisos-de-falha`,children:`Avisos de falha`}),`. `,_jsx(_components.code,{children:`null`}),`\nenquanto estiver ativo.`]})}),`\n`,_jsx(ResponseField,{name:`failing_since`,type:`string`,id:`param-failing-since`,children:_jsxs(_components.p,{children:[`Instante ISO 8601 UTC em que começou a sequência atual de falhas. `,_jsx(_components.code,{children:`null`}),` quando a última entrega teve sucesso.`]})}),`\n`,_jsx(ResponseField,{name:`previous_secret_expires_at`,type:`string`,id:`param-previous-secret-expires-at`,children:_jsxs(_components.p,{children:[`Instante ISO 8601 UTC em que o segredo anterior deixa de assinar. `,_jsx(_components.code,{children:`null`}),` quando não há rotação em curso.`]})}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`string`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`Instante ISO 8601 UTC em que o webhook foi criado.`})}),`\n`,_jsx(ResponseField,{name:`updated_at`,type:`string`,required:true,id:`param-updated-at`,children:_jsx(_components.p,{children:`Instante ISO 8601 UTC da última alteração.`})}),`\n`,_jsx(Heading,{level:`2`,id:`respostas-de-erro`,children:`Respostas de erro`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Estado`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Pedido inválido, por exemplo um URL incorreto, um tipo de evento desconhecido, `,_jsx(_components.code,{children:`alert_emails`}),` inválidos ou uma chave de API que não pode ter um webhook.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Chave de API inválida.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`Sem chave de API, ou uma chave de API sem o âmbito `,_jsx(_components.code,{children:`webhooks_manage`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`A tua chave de API já tem 5 webhooks.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Erro interno do servidor.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Criar webhook","description":"Registar um URL que recebe eventos de webhook","api":"POST https://anivahealth.com/api/v1/webhooks","href":"/pt/api/webhooks/create-webhook"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Regista um URL HTTPS que recebe `,_jsx(_components.a,{href:`/pt/concepts/webhooks`,children:`eventos de webhook`}),`. A tua chave de API é a proprietária do\nwebhook. Este recebe um evento apenas para objetos que a tua chave consegue ler. Uma chave de API pode ter no máximo 5\nwebhooks.`]}),`\n`,_jsxs(Note,{children:[`Requer o âmbito `,_jsx(_components.code,{children:`webhooks_manage`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`pedido`,children:`Pedido`}),`\n`,_jsx(Heading,{level:`3`,id:`parâmetros-do-corpo`,children:`Parâmetros do corpo`}),`\n`,_jsx(ParamField,{body:`url`,type:`string`,required:true,id:`param-url`,children:_jsx(_components.p,{children:`URL HTTPS na porta 443 com um host público e sem credenciais. A Aniva não segue redirecionamentos.`})}),`\n`,_jsx(ParamField,{body:`enabled_events`,type:`string[]`,required:true,id:`param-enabled-events`,children:_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/pt/concepts/webhooks#eventos`,children:`Tipos de eventos`}),` a receber, pelo menos um. `,_jsx(_components.code,{children:`[\"*\"]`}),` significa todos os tipos.\n`,_jsx(_components.code,{children:`ping`}),` não pode ser listado.`]})}),`\n`,_jsx(ParamField,{body:`alert_emails`,type:`string[]`,required:true,id:`param-alert-emails`,children:_jsx(_components.p,{children:`1 a 5 endereços para os quais a Aniva envia email quando as entregas continuam a falhar.`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Texto livre para a tua própria referência, no máximo 500 caracteres.`})}),`\n`,_jsx(Heading,{level:`2`,id:`resposta`,children:`Resposta`}),`\n`,_jsxs(_components.p,{children:[`Em caso de sucesso, a API devolve `,_jsx(_components.code,{children:`201 Created`}),` com o webhook e o seu segredo.`]}),`\n`,_jsx(ResponseField,{name:`secret`,type:`string`,required:true,id:`param-secret`,children:_jsxs(_components.p,{children:[`O segredo de assinatura, `,_jsx(_components.code,{children:`whsec_`}),` seguido de base64. A Aniva mostra-o apenas nesta resposta. Consulta `,_jsx(_components.a,{href:`/pt/concepts/webhooks#verificar-a-assinatura`,children:`Verificar a\nassinatura`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Identificador do webhook (UUID).`})}),`\n`,_jsx(ResponseField,{name:`url`,type:`string`,required:true,id:`param-url-1`,children:_jsx(_components.p,{children:`O URL HTTPS para o qual a Aniva envia os eventos.`})}),`\n`,_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-1`,children:_jsxs(_components.p,{children:[`Texto livre para a tua própria referência. Pode ser `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`enabled_events`,type:`string[]`,required:true,id:`param-enabled-events-1`,children:_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/pt/concepts/webhooks#eventos`,children:`Tipos de eventos`}),` que este webhook recebe. `,_jsx(_components.code,{children:`*`}),` significa todos os tipos.`]})}),`\n`,_jsx(ResponseField,{name:`alert_emails`,type:`string[]`,required:true,id:`param-alert-emails-1`,children:_jsx(_components.p,{children:`Endereços para os quais a Aniva envia email quando as entregas continuam a falhar.`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`enabled`}),` ou `,_jsx(_components.code,{children:`disabled`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`disabled_at`,type:`string`,id:`param-disabled-at`,children:_jsxs(_components.p,{children:[`Instante ISO 8601 UTC em que o webhook foi desativado. `,_jsx(_components.code,{children:`null`}),` enquanto estiver ativo.`]})}),`\n`,_jsx(ResponseField,{name:`disabled_reason`,type:`string`,id:`param-disabled-reason`,children:_jsxs(_components.p,{children:[`Motivo pelo qual o webhook foi desativado. Consulta `,_jsx(_components.a,{href:`/pt/concepts/webhooks#avisos-de-falha`,children:`Avisos de falha`}),`. `,_jsx(_components.code,{children:`null`}),`\nenquanto estiver ativo.`]})}),`\n`,_jsx(ResponseField,{name:`failing_since`,type:`string`,id:`param-failing-since`,children:_jsxs(_components.p,{children:[`Instante ISO 8601 UTC em que começou a sequência atual de falhas. `,_jsx(_components.code,{children:`null`}),` quando a última entrega teve sucesso.`]})}),`\n`,_jsx(ResponseField,{name:`previous_secret_expires_at`,type:`string`,id:`param-previous-secret-expires-at`,children:_jsxs(_components.p,{children:[`Instante ISO 8601 UTC em que o segredo anterior deixa de assinar. `,_jsx(_components.code,{children:`null`}),` quando não há rotação em curso.`]})}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`string`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`Instante ISO 8601 UTC em que o webhook foi criado.`})}),`\n`,_jsx(ResponseField,{name:`updated_at`,type:`string`,required:true,id:`param-updated-at`,children:_jsx(_components.p,{children:`Instante ISO 8601 UTC da última alteração.`})}),`\n`,_jsx(Heading,{level:`2`,id:`respostas-de-erro`,children:`Respostas de erro`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Estado`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Pedido inválido, por exemplo um URL incorreto, um tipo de evento desconhecido, `,_jsx(_components.code,{children:`alert_emails`}),` inválidos ou uma chave de API que não pode ter um webhook.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Chave de API inválida.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`Sem chave de API, ou uma chave de API sem o âmbito `,_jsx(_components.code,{children:`webhooks_manage`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`A tua chave de API já tem 5 webhooks.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Erro interno do servidor.`})]})]})]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`16`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`16`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://anivahealth.com/api/v1/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'x-api-key: YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"url\": \"https://partner.example.com/webhooks/aniva\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"enabled_events\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"appointment.confirmed\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"appointment.results.completed\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"home_kit_order.results.completed\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"alert_emails\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"ops@partner.example.com\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"description\": \"Production\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`201`,numberOfLines:`19`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"secret\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw8L0qsE2bkS4=\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://partner.example.com/webhooks/aniva\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Production\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"enabled_events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"appointment.confirmed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"appointment.results.completed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"home_kit_order.results.completed\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"alert_emails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ops@partner.example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"enabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"disabled_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"disabled_reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"failing_since\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"previous_secret_expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-15T08:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-15T08:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`400`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"url must use https\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`409`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"An API key can own at most 5 webhooks\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Criar webhook","description":"Registar um URL que recebe eventos de webhook","api":"POST https://anivahealth.com/api/v1/webhooks","href":"/pt/api/webhooks/create-webhook"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Pedido","slug":"pedido","depth":2,"children":[{"title":"Parâmetros do corpo","slug":"parâmetros-do-corpo","depth":3,"children":[]}]},{"title":"Resposta","slug":"resposta","depth":2,"children":[]},{"title":"Respostas de erro","slug":"respostas-de-erro","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"16\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://anivahealth.com/api/v1/webhooks\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'x-api-key: YOUR_API_KEY'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"url\": \"https://partner.example.com/webhooks/aniva\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"enabled_events\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"appointment.confirmed\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"appointment.results.completed\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"home_kit_order.results.completed\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"alert_emails\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"ops@partner.example.com\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"description\": \"Production\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"201","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"19\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"secret\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw8L0qsE2bkS4=\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://partner.example.com/webhooks/aniva\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Production\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"enabled_events\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"appointment.confirmed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"appointment.results.completed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"home_kit_order.results.completed\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"alert_emails\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ops@partner.example.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"enabled\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"disabled_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"disabled_reason\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"failing_since\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"previous_secret_expires_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-10-15T08:00:00.000Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"updated_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-10-15T08:00:00.000Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"400","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"url must use https\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"409","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"An API key can own at most 5 webhooks\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Criar webhook","path":"/api/v1/webhooks","servers":[{"url":"https://anivahealth.com"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"x-api-key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"url":[{"type":"string","description":"URL HTTPS na porta 443 com um host público e sem credenciais. A Aniva não segue redirecionamentos.","required":true}],"enabled_events":[{"type":"array","items":[{"type":"string"}],"description":"Tipos de eventos a receber, pelo menos um. `[\"*\"]` significa todos os tipos. `ping` não pode ser listado.","required":true}],"alert_emails":[{"type":"array","items":[{"type":"string"}],"description":"1 a 5 endereços para os quais a Aniva envia email quando as entregas continuam a falhar.","required":true}],"description":[{"type":"string","description":"Texto livre para a tua própria referência, no máximo 500 caracteres."}]}}],"examples":{"example":{"value":{"url":"\u003cstring>","enabled_events":["\u003cstring>"],"alert_emails":["\u003cstring>"],"description":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"secret":[{"type":"string","description":"O segredo de assinatura, `whsec_` seguido de base64. A Aniva mostra-o apenas nesta resposta. Consulta Verificar a assinatura .","required":true}],"id":[{"type":"string","description":"Identificador do webhook (UUID).","required":true}],"url":[{"type":"string","description":"O URL HTTPS para o qual a Aniva envia os eventos.","required":true}],"description":[{"type":"string","description":"Texto livre para a tua própria referência. Pode ser `null` ."}],"enabled_events":[{"type":"array","items":[{"type":"string"}],"description":"Tipos de eventos que este webhook recebe. `*` significa todos os tipos.","required":true}],"alert_emails":[{"type":"array","items":[{"type":"string"}],"description":"Endereços para os quais a Aniva envia email quando as entregas continuam a falhar.","required":true}],"status":[{"type":"string","description":"`enabled` ou `disabled` .","required":true}],"disabled_at":[{"type":"string","description":"Instante ISO 8601 UTC em que o webhook foi desativado. `null` enquanto estiver ativo."}],"disabled_reason":[{"type":"string","description":"Motivo pelo qual o webhook foi desativado. Consulta Avisos de falha . `null` enquanto estiver ativo."}],"failing_since":[{"type":"string","description":"Instante ISO 8601 UTC em que começou a sequência atual de falhas. `null` quando a última entrega teve sucesso."}],"previous_secret_expires_at":[{"type":"string","description":"Instante ISO 8601 UTC em que o segredo anterior deixa de assinar. `null` quando não há rotação em curso."}],"created_at":[{"type":"string","description":"Instante ISO 8601 UTC em que o webhook foi criado.","required":true}],"updated_at":[{"type":"string","description":"Instante ISO 8601 UTC da última alteração.","required":true}]}}],"examples":{"example":{"value":{"secret":"\u003cstring>","id":"\u003cstring>","url":"\u003cstring>","description":"\u003cstring>","enabled_events":["\u003cstring>"],"alert_emails":["\u003cstring>"],"status":"\u003cstring>","disabled_at":"\u003cstring>","disabled_reason":"\u003cstring>","failing_since":"\u003cstring>","previous_secret_expires_at":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/anivahealth/5d0d870ff743f803/video-zoom.js"],"subdomain":"anivahealth","siteName":"Aniva API","title":"Criar webhook - Aniva API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api/webhooks/create-webhook","matchLevel":1},"de":{"href":"/de/api/webhooks/create-webhook","matchLevel":1},"ca":{"href":"/ca/api/webhooks/create-webhook","matchLevel":1},"cs":{"href":"/cs/api/webhooks/create-webhook","matchLevel":1},"da":{"href":"/da/api/webhooks/create-webhook","matchLevel":1},"es":{"href":"/es/api/webhooks/create-webhook","matchLevel":1},"fi":{"href":"/fi/api/webhooks/create-webhook","matchLevel":1},"fr":{"href":"/fr/api/webhooks/create-webhook","matchLevel":1},"hu":{"href":"/hu/api/webhooks/create-webhook","matchLevel":1},"it":{"href":"/it/api/webhooks/create-webhook","matchLevel":1},"lv":{"href":"/lv/api/webhooks/create-webhook","matchLevel":1},"nl":{"href":"/nl/api/webhooks/create-webhook","matchLevel":1},"no":{"href":"/no/api/webhooks/create-webhook","matchLevel":1},"pl":{"href":"/pl/api/webhooks/create-webhook","matchLevel":1},"pt":{"href":"/pt/api/webhooks/create-webhook","matchLevel":0},"ro":{"href":"/ro/api/webhooks/create-webhook","matchLevel":1},"ru":{"href":"/ru/api/webhooks/create-webhook","matchLevel":1},"sv":{"href":"/sv/api/webhooks/create-webhook","matchLevel":1},"tr":{"href":"/tr/api/webhooks/create-webhook","matchLevel":1},"uk":{"href":"/uk/api/webhooks/create-webhook","matchLevel":1}}},"lastModified":"2026-11-22T10:00:15.564Z","originalFileLocation":"pt/api/webhooks/create-webhook.mdx","locale":"pt"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Registar um URL que recebe eventos de webhook\">\u003cmeta data-mint-head name=\"keywords\" content=\"blood test API, lab testing API, home test kit API, lab results API, biomarker API, pharmacy blood test, Germany, EU\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aniva API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Criar webhook - Aniva API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registar um URL que recebe eventos de webhook\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aniva Partner API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://anivahealth.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Criar+webhook\u0026amp;description=Registar+um+URL+que+recebe+eventos+de+webhook\u0026amp;theme=ee63c32abd41d12dcedcfed1\u0026amp;signature=86a92f1c38f30c01163cdd00d92505dd857ee91c6ff0d00c9295dbafa7425213\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Criar webhook - Aniva API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registar um URL que recebe eventos de webhook\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://anivahealth.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Criar+webhook\u0026amp;description=Registar+um+URL+que+recebe+eventos+de+webhook\u0026amp;theme=ee63c32abd41d12dcedcfed1\u0026amp;signature=86a92f1c38f30c01163cdd00d92505dd857ee91c6ff0d00c9295dbafa7425213\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/anivahealth/xxvf_NPPRJ8RsT4T/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aniva API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e76c2b\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt/api/webhooks/create-webhook.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.anivahealth.com/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.anivahealth.com/de/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://docs.anivahealth.com/ca/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"cs\" href=\"https://docs.anivahealth.com/cs/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"da\" href=\"https://docs.anivahealth.com/da/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.anivahealth.com/es/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fi\" href=\"https://docs.anivahealth.com/fi/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.anivahealth.com/fr/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hu\" href=\"https://docs.anivahealth.com/hu/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.anivahealth.com/it/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"lv\" href=\"https://docs.anivahealth.com/lv/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"nl\" href=\"https://docs.anivahealth.com/nl/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"no\" href=\"https://docs.anivahealth.com/no/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pl\" href=\"https://docs.anivahealth.com/pl/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ro\" href=\"https://docs.anivahealth.com/ro/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.anivahealth.com/ru/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"sv\" href=\"https://docs.anivahealth.com/sv/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"tr\" href=\"https://docs.anivahealth.com/tr/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"uk\" href=\"https://docs.anivahealth.com/uk/api/webhooks/create-webhook\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.anivahealth.com/api/webhooks/create-webhook\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.anivahealth.com/#organization\",\"name\":\"Aniva API\",\"url\":\"https://docs.anivahealth.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/anivahealth/3R-RUSdQmYnR_d5s/images/aniva.svg?fit=max\u0026auto=format\u0026n=3R-RUSdQmYnR_d5s\u0026q=85\u0026s=07e4ee4fd57b9ccbe6809fe000f33fdd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.anivahealth.com#website\",\"name\":\"Aniva API\",\"url\":\"https://docs.anivahealth.com\",\"publisher\":{\"@id\":\"https://docs.anivahealth.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook#webpage\",\"url\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook\",\"name\":\"Criar webhook\",\"description\":\"Registar um URL que recebe eventos de webhook\",\"dateModified\":\"2026-11-22T10:00:15.564Z\",\"isPartOf\":{\"@id\":\"https://docs.anivahealth.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.anivahealth.com/pt/api/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar webhook\",\"item\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook#apireference\",\"headline\":\"Criar webhook\",\"name\":\"Criar webhook\",\"description\":\"Registar um URL que recebe eventos de webhook\",\"url\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.anivahealth.com/pt/api/webhooks/create-webhook#webpage\"},\"dateModified\":\"2026-11-22T10:00:15.564Z\",\"publisher\":{\"@id\":\"https://docs.anivahealth.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.anivahealth.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aniva API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Aniva API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pt/api/webhooks/create-webhook.md","siteName":"Aniva API","nav":{"global":null,"languages":[{"language":"en","pages":[{"title":"en","href":"/api/webhooks/create-webhook"}]},{"language":"de","navbar":{"links":[{"href":"/de/changelog","label":"Changelog"},{"href":"/de/status","label":"Status"}]},"pages":[{"title":"de","href":"/de/api/webhooks/create-webhook"}]},{"language":"ca","navbar":{"links":[{"href":"/ca/changelog","label":"Registre de canvis"},{"href":"/ca/status","label":"Estat"}]},"pages":[{"title":"ca","href":"/ca/api/webhooks/create-webhook"}]},{"language":"cs","navbar":{"links":[{"href":"/cs/changelog","label":"Seznam změn"},{"href":"/cs/status","label":"Stav"}]},"pages":[{"title":"cs","href":"/cs/api/webhooks/create-webhook"}]},{"language":"da","navbar":{"links":[{"href":"/da/changelog","label":"Ændringslog"},{"href":"/da/status","label":"Status"}]},"pages":[{"title":"da","href":"/da/api/webhooks/create-webhook"}]},{"language":"es","navbar":{"links":[{"href":"/es/changelog","label":"Registro de cambios"},{"href":"/es/status","label":"Estado"}]},"pages":[{"title":"es","href":"/es/api/webhooks/create-webhook"}]},{"language":"fi","navbar":{"links":[{"href":"/fi/changelog","label":"Muutosloki"},{"href":"/fi/status","label":"Tila"}]},"pages":[{"title":"fi","href":"/fi/api/webhooks/create-webhook"}]},{"language":"fr","navbar":{"links":[{"href":"/fr/changelog","label":"Journal des modifications"},{"href":"/fr/status","label":"Statut"}]},"pages":[{"title":"fr","href":"/fr/api/webhooks/create-webhook"}]},{"language":"hu","navbar":{"links":[{"href":"/hu/changelog","label":"Változásnapló"},{"href":"/hu/status","label":"Állapot"}]},"pages":[{"title":"hu","href":"/hu/api/webhooks/create-webhook"}]},{"language":"it","navbar":{"links":[{"href":"/it/changelog","label":"Changelog"},{"href":"/it/status","label":"Stato"}]},"pages":[{"title":"it","href":"/it/api/webhooks/create-webhook"}]},{"language":"lv","navbar":{"links":[{"href":"/lv/changelog","label":"Izmaiņu žurnāls"},{"href":"/lv/status","label":"Statuss"}]},"pages":[{"title":"lv","href":"/lv/api/webhooks/create-webhook"}]},{"language":"nl","navbar":{"links":[{"href":"/nl/changelog","label":"Changelog"},{"href":"/nl/status","label":"Status"}]},"pages":[{"title":"nl","href":"/nl/api/webhooks/create-webhook"}]},{"language":"no","navbar":{"links":[{"href":"/no/changelog","label":"Endringslogg"},{"href":"/no/status","label":"Status"}]},"pages":[{"title":"no","href":"/no/api/webhooks/create-webhook"}]},{"language":"pl","navbar":{"links":[{"href":"/pl/changelog","label":"Dziennik zmian"},{"href":"/pl/status","label":"Status"}]},"pages":[{"title":"pl","href":"/pl/api/webhooks/create-webhook"}]},{"language":"pt","navbar":{"links":[{"href":"/pt/changelog","label":"Registo de alterações"},{"href":"/pt/status","label":"Estado"}]},"tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/pt"}]},{"tab":"Referência da API","groups":[{"group":"Saúde","pages":[{"title":"Verificação de estado","api":"GET https://anivahealth.com/api/v1/health","href":"/pt/api/health/check-health"}]},{"group":"Perfis","pages":[{"title":"Listar perfis","api":"GET https://anivahealth.com/api/v1/profiles","href":"/pt/api/profiles/list-profiles"},{"title":"Criar perfil","api":"POST https://anivahealth.com/api/v1/profiles","href":"/pt/api/profiles/create-profile"},{"title":"Obter perfil","api":"GET https://anivahealth.com/api/v1/profiles/{id}","href":"/pt/api/profiles/get-profile"},{"title":"Atualizar perfil","api":"PATCH https://anivahealth.com/api/v1/profiles/{id}","href":"/pt/api/profiles/update-profile"},{"title":"Criar sessão de incorporação","api":"POST https://anivahealth.com/api/v1/profiles/{id}/embed-sessions","href":"/pt/api/profiles/create-embed-session"}]},{"group":"Marcações","pages":[{"title":"Listar marcações","api":"GET https://anivahealth.com/api/v1/appointments","href":"/pt/api/appointments/list-appointments"},{"title":"Criar marcação","api":"POST https://anivahealth.com/api/v1/appointments","href":"/pt/api/appointments/create-appointment"},{"title":"Obter marcação","api":"GET https://anivahealth.com/api/v1/appointments/{id}","href":"/pt/api/appointments/get-appointment"},{"title":"Atualizar marcação","api":"PATCH https://anivahealth.com/api/v1/appointments/{id}","href":"/pt/api/appointments/update-appointment"},{"title":"Cancelar marcação","api":"DELETE https://anivahealth.com/api/v1/appointments/{id}","href":"/pt/api/appointments/cancel-appointment"},{"title":"Adicionar painéis","api":"POST https://anivahealth.com/api/v1/appointments/{id}/panels","href":"/pt/api/appointments/add-panels"},{"title":"Remover painéis","api":"DELETE https://anivahealth.com/api/v1/appointments/{id}/panels","href":"/pt/api/appointments/remove-panels"},{"title":"Adicionar biomarcadores individuais","api":"PATCH https://anivahealth.com/api/v1/appointments/{id}/biomarkers","href":"/pt/api/appointments/add-individual-biomarkers"},{"title":"Remover biomarcadores individuais","api":"DELETE https://anivahealth.com/api/v1/appointments/{id}/biomarkers","href":"/pt/api/appointments/remove-individual-biomarkers"},{"title":"Pré-visualizar marcação","api":"GET https://anivahealth.com/api/v1/appointments/{id}/preview","href":"/pt/api/appointments/preview-containers"},{"title":"Confirmar colheita de sangue","api":"POST https://anivahealth.com/api/v1/appointments/{id}/confirm","href":"/pt/api/appointments/confirm-blood-draw"},{"title":"Obter resultados laboratoriais","api":"GET https://anivahealth.com/api/v1/appointments/{id}/results","href":"/pt/api/appointments/get-results"},{"title":"Enviar resultados por e-mail","api":"POST https://anivahealth.com/api/v1/appointments/{id}/results/email","href":"/pt/api/appointments/email-results"}]},{"group":"Encomendas de kits de teste em casa","pages":[{"title":"Listar encomendas de kit de teste em casa","api":"GET https://anivahealth.com/api/v1/home-kit-orders","href":"/pt/api/home-kit-orders/list-home-kits"},{"title":"Criar encomenda de kit de teste em casa","api":"POST https://anivahealth.com/api/v1/home-kit-orders","href":"/pt/api/home-kit-orders/create-home-kit"},{"title":"Obter encomenda de kit de teste em casa","api":"GET https://anivahealth.com/api/v1/home-kit-orders/{id}","href":"/pt/api/home-kit-orders/get-home-kit"},{"title":"Atualizar encomenda de kit de teste em casa","api":"PATCH https://anivahealth.com/api/v1/home-kit-orders/{id}","href":"/pt/api/home-kit-orders/update-home-kit"},{"title":"Cancelar encomenda de kit de teste em casa","api":"DELETE https://anivahealth.com/api/v1/home-kit-orders/{id}","href":"/pt/api/home-kit-orders/cancel-home-kit"},{"title":"Ativar encomenda de kit de teste em casa","api":"POST https://anivahealth.com/api/v1/home-kit-orders/{id}/activate","href":"/pt/api/home-kit-orders/activate-home-kit"},{"title":"Adicionar biomarcadores individuais","api":"PATCH https://anivahealth.com/api/v1/home-kit-orders/{id}/biomarkers","href":"/pt/api/home-kit-orders/add-individual-biomarkers"},{"title":"Remover biomarcadores individuais","api":"DELETE https://anivahealth.com/api/v1/home-kit-orders/{id}/biomarkers","href":"/pt/api/home-kit-orders/remove-individual-biomarkers"},{"title":"Obter resultados laboratoriais","api":"GET https://anivahealth.com/api/v1/home-kit-orders/{id}/results","href":"/pt/api/home-kit-orders/get-results"},{"title":"Enviar resultados por e-mail","api":"POST https://anivahealth.com/api/v1/home-kit-orders/{id}/results/email","href":"/pt/api/home-kit-orders/email-results"}]},{"group":"Catálogo de testes","pages":[{"title":"Listar biomarcadores","api":"GET https://anivahealth.com/api/v1/biomarkers","href":"/pt/api/biomarkers/list-biomarkers"},{"title":"Obter biomarcador","api":"GET https://anivahealth.com/api/v1/biomarkers/{id}","href":"/pt/api/biomarkers/get-biomarker"},{"title":"Listar painéis","api":"GET https://anivahealth.com/api/v1/panels","href":"/pt/api/panels/list-panels"}]},{"group":"Preços","pages":[{"title":"Obter tabela de tarifas","api":"GET https://anivahealth.com/api/v1/pricing/rate-card","href":"/pt/api/pricing/get-rate-card"},{"title":"Orçamentar carrinho","api":"POST https://anivahealth.com/api/v1/pricing/quote","href":"/pt/api/pricing/quote-cart"}]},{"group":"Unidades","pages":[{"title":"Listar unidades","api":"GET https://anivahealth.com/api/v1/units","href":"/pt/api/units/list-units"}]},{"group":"Locais","pages":[{"title":"Listar locais","api":"GET https://anivahealth.com/api/v1/locations","href":"/pt/api/locations/list-locations"},{"title":"Obter local","api":"GET https://anivahealth.com/api/v1/locations/{id}","href":"/pt/api/locations/get-location"},{"title":"Obter disponibilidade","api":"GET https://anivahealth.com/api/v1/locations/{id}/availability","href":"/pt/api/locations/get-availability"},{"title":"Listar preços ao público","api":"GET https://anivahealth.com/api/v1/locations/retail-prices","href":"/pt/api/locations/list-retail-prices"},{"title":"Obter preços ao público","api":"GET https://anivahealth.com/api/v1/locations/{id}/retail-prices","href":"/pt/api/locations/get-retail-prices"}]},{"group":"Documentos","pages":[{"title":"Carregar documento","api":"POST https://anivahealth.com/api/v1/documents","href":"/pt/api/documents/upload-document"},{"title":"Obter resultados do documento","api":"GET https://anivahealth.com/api/v1/documents/{id}/results","href":"/pt/api/documents/get-document-results"},{"title":"Transferir documento","api":"GET https://anivahealth.com/api/v1/documents/{id}","href":"/pt/api/documents/download-document"},{"title":"Eliminar documento","api":"DELETE https://anivahealth.com/api/v1/documents/{id}","href":"/pt/api/documents/delete-document"}]},{"group":"Envios","pages":[{"title":"Criar envio","api":"POST https://anivahealth.com/api/v1/shipments","href":"/pt/api/shipments/create-shipment"},{"title":"Listar envios","api":"GET https://anivahealth.com/api/v1/shipments","href":"/pt/api/shipments/list-shipments"},{"title":"Obter envio","api":"GET https://anivahealth.com/api/v1/shipments/{id}","href":"/pt/api/shipments/get-shipment"},{"title":"Atualizar envio","api":"PATCH https://anivahealth.com/api/v1/shipments/{id}","href":"/pt/api/shipments/update-shipment"},{"title":"Cancelar envio","api":"DELETE https://anivahealth.com/api/v1/shipments/{id}","href":"/pt/api/shipments/cancel-shipment"},{"title":"Listar marcações do envio","api":"GET https://anivahealth.com/api/v1/shipments/{id}/appointments","href":"/pt/api/shipments/list-shipment-appointments"},{"title":"Associar marcações ao envio","api":"POST https://anivahealth.com/api/v1/shipments/{id}/appointments","href":"/pt/api/shipments/attach-appointments-to-shipment"},{"title":"Desassociar marcações do envio","api":"DELETE https://anivahealth.com/api/v1/shipments/{id}/appointments","href":"/pt/api/shipments/detach-appointments-from-shipment"}]},{"group":"Webhooks","pages":[{"title":"Listar webhooks","description":"Listar os webhooks que pertencem à tua chave de API","api":"GET https://anivahealth.com/api/v1/webhooks","href":"/pt/api/webhooks/list-webhooks"},{"title":"Criar webhook","api":"POST https://anivahealth.com/api/v1/webhooks","href":"/pt/api/webhooks/create-webhook"},{"title":"Obter webhook","description":"Obter um webhook","api":"GET https://anivahealth.com/api/v1/webhooks/{id}","href":"/pt/api/webhooks/get-webhook"},{"title":"Atualizar webhook","api":"PATCH https://anivahealth.com/api/v1/webhooks/{id}","href":"/pt/api/webhooks/update-webhook"},{"title":"Eliminar webhook","api":"DELETE https://anivahealth.com/api/v1/webhooks/{id}","href":"/pt/api/webhooks/delete-webhook"},{"title":"Rodar segredo","api":"POST https://anivahealth.com/api/v1/webhooks/{id}/rotate-secret","href":"/pt/api/webhooks/rotate-secret"},{"title":"Enviar evento de teste","api":"POST https://anivahealth.com/api/v1/webhooks/{id}/ping","href":"/pt/api/webhooks/send-test-event"},{"title":"Listar entregas","api":"GET https://anivahealth.com/api/v1/webhooks/{id}/deliveries","href":"/pt/api/webhooks/list-deliveries"},{"title":"Reenviar entrega","api":"POST https://anivahealth.com/api/v1/webhooks/{id}/deliveries/{delivery_id}/resend","href":"/pt/api/webhooks/resend-delivery"}]}]}]},{"language":"ro","navbar":{"links":[{"href":"/ro/changelog","label":"Jurnal de modificări"},{"href":"/ro/status","label":"Stare"}]},"pages":[{"title":"ro","href":"/ro/api/webhooks/create-webhook"}]},{"language":"ru","navbar":{"links":[{"href":"/ru/changelog","label":"История изменений"},{"href":"/ru/status","label":"Статус"}]},"pages":[{"title":"ru","href":"/ru/api/webhooks/create-webhook"}]},{"language":"sv","navbar":{"links":[{"href":"/sv/changelog","label":"Ändringslogg"},{"href":"/sv/status","label":"Status"}]},"pages":[{"title":"sv","href":"/sv/api/webhooks/create-webhook"}]},{"language":"tr","navbar":{"links":[{"href":"/tr/changelog","label":"Değişiklik günlüğü"},{"href":"/tr/status","label":"Durum"}]},"pages":[{"title":"tr","href":"/tr/api/webhooks/create-webhook"}]},{"language":"uk","navbar":{"links":[{"href":"/uk/changelog","label":"Історія змін"},{"href":"/uk/status","label":"Статус"}]},"pages":[{"title":"uk","href":"/uk/api/webhooks/create-webhook"}]}]},"basePath":"","title":"Criar webhook - Aniva API","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","b0f84f53ff","2b790eda92"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","Page-DuqezyvM.js","CodeSnippet-B373COAT.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","getApiPlaygroundDisplay-CfL-UuDS.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js"]}