[{"data":1,"prerenderedAt":549},["ShallowReactive",2],{"docs-pages-meta":3,"i-lucide:menu":142,"i-fa6-solid:book":147,"i-fa6-solid:signs-post":151,"i-lucide:search":153,"i-lucide:languages":155,"i-lucide:chevron-down":157,"i-lucide:moon":159,"i-fa6-solid:rocket":161,"i-lucide:sparkles":163,"i-lucide:badge-check":165,"i-lucide:star":167,"i-fa6-solid:qrcode":169,"i-fa6-solid:cube":171,"i-lucide:webhook":173,"i-fa6-brands:wordpress":175,"i-fa6-solid:envelope":177,"i-fa6-solid:code":179,"i-fa6-solid:key":182,"docs-page:\u002Fen\u002Fapikeys":184,"i-fa6-solid:triangle-exclamation":541,"i-lucide:copy":543,"i-fa6-solid:circle-info":545,"i-lucide:chevron-left":547},[4,9,14,19,22,27,30,35,38,42,47,52,56,61,66,71,76,79,83,87,90,93,97,100,104,107,111,115,119,123,127,131,135,139],{"path":5,"title":6,"description":7,"icon":8},"\u002Fen\u002Fapi-reference\u002Fv2\u002Fauthentication","Authentication","Learn how to generate and manage your access credentials to use the API securely.","key",{"path":10,"title":11,"description":12,"icon":13},"\u002Fen\u002Fapi-reference\u002Fv2","Introduction","The v2 API: connections, chats, messages and templates.","sparkles",{"path":15,"title":16,"description":17,"icon":18},"\u002Fen\u002Fapi-reference\u002Fv2\u002Fwebhooks","Webhooks","In this section, you’ll learn how to integrate and use webhooks and messaging events to connect your application to your projects.","webhook",{"path":20,"title":6,"description":21,"icon":8},"\u002Fen\u002Fapi-reference\u002Fv3\u002Fauthentication","How a v3 request proves who it is, and which workspace it acts on.",{"path":23,"title":24,"description":25,"icon":26},"\u002Fen\u002Fapi-reference\u002Fv3\u002Fconventions","Conventions","Pagination, errors, ids and dates — the rules every v3 endpoint follows.","list-check",{"path":28,"title":11,"description":29,"icon":13},"\u002Fen\u002Fapi-reference\u002Fv3","The v3 API: workspaces, connections, campaigns and the helpdesk.",{"path":31,"title":32,"description":33,"icon":34},"\u002Fen\u002Fapi-reference\u002Fv3\u002Frealtime","Realtime","The websocket behind the shared inbox: live conversations, typing and presence.","tower-broadcast",{"path":36,"title":16,"description":37,"icon":18},"\u002Fen\u002Fapi-reference\u002Fv3\u002Fwebhooks","Receive WhatsApp and helpdesk events on your own server, and prove they came from us.",{"path":39,"title":40,"description":41,"icon":8},"\u002Fen\u002Fapikeys","API Keys","Understand what API Keys are and why they are required to use Pingo Notify securely.",{"path":43,"title":44,"description":45,"icon":46},"\u002Fen\u002Fconnections","Connections","Connections represent WhatsApp sessions linked to Pingo Notify, used for sending, receiving, and integrations.","qrcode",{"path":48,"title":49,"description":50,"icon":51},"\u002Fen\u002Fhooks-and-development","Hooks and Development","Extend the Pingo Notify WordPress plugin with custom triggers, groups, and hooks.","code",{"path":53,"title":54,"description":55,"icon":13},"\u002Fen","Introduction to Pingo Notify","Connect WhatsApp to your systems, automate workflows, and send messages.",{"path":57,"title":58,"description":59,"icon":60},"\u002Fen\u002Fintegrations","Integrations","Integrations represent external applications linked to Pingo Notify, authorized to access resources such as connections, plans, and messaging.","cube",{"path":62,"title":63,"description":64,"icon":65},"\u002Fen\u002Fofficial-whatsapp-api","Official WhatsApp API","Step-by-step guide to request access to the Official WhatsApp Business API and connect it to Pingo Notify.","badge-check",{"path":67,"title":68,"description":69,"icon":70},"\u002Fen\u002Fplugin-wordpress","Get started","WordPress plugin that connects events from your site to Pingo Notify for automatic notification delivery.","wordpress",{"path":72,"title":73,"description":74,"icon":75},"\u002Fen\u002Ftemplate-plugins","Templates Guide","Learn how to create custom dynamic messages.","square-envelope",{"path":77,"title":16,"description":78,"icon":18},"\u002Fen\u002Fwebhooks","Receive WhatsApp events in real time by linking webhooks to one or more connections in Pingo Notify.",{"path":80,"title":81,"description":82,"icon":8},"\u002Fpt-BR\u002Fapi-reference\u002Fv2\u002Fauthentication","Autenticação","Veja como gerar e gerenciar suas credenciais de acesso para utilizar a API com segurança.",{"path":84,"title":85,"description":86,"icon":13},"\u002Fpt-BR\u002Fapi-reference\u002Fv2","Introdução","A API v2: conexões, conversas, mensagens e templates.",{"path":88,"title":16,"description":89,"icon":18},"\u002Fpt-BR\u002Fapi-reference\u002Fv2\u002Fwebhooks","Nesta seção, você aprende como integrar e utilizar webhooks e eventos de mensageria para conectar a aplicação aos seus projetos.",{"path":91,"title":81,"description":92,"icon":8},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Fauthentication","Como uma requisição v3 prova quem é, e em qual workspace ela atua.",{"path":94,"title":95,"description":96,"icon":26},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Fconventions","Convenções","Paginação, erros, ids e datas — as regras que todo endpoint da v3 segue.",{"path":98,"title":85,"description":99,"icon":13},"\u002Fpt-BR\u002Fapi-reference\u002Fv3","A API v3: workspaces, conexões, campanhas e o helpdesk.",{"path":101,"title":102,"description":103,"icon":34},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Frealtime","Tempo real","O websocket por trás da caixa compartilhada: conversas ao vivo, digitação e presença.",{"path":105,"title":16,"description":106,"icon":18},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Fwebhooks","Receba eventos do WhatsApp e do helpdesk no seu servidor, e prove que vieram de nós.",{"path":108,"title":109,"description":110,"icon":8},"\u002Fpt-BR\u002Fapikeys","Chaves de API","Entenda o que são Chaves de API e por que elas são necessárias para usar o Pingo Notify com segurança.",{"path":112,"title":113,"description":114,"icon":46},"\u002Fpt-BR\u002Fconnections","Conexões","Conexões representam sessões do WhatsApp vinculadas ao Pingo Notify, usadas para envio, recebimento e integrações.",{"path":116,"title":117,"description":118,"icon":51},"\u002Fpt-BR\u002Fhooks-and-development","Hooks e Desenvolvimento","Estenda o plugin WordPress do Pingo Notify com gatilhos, grupos e hooks personalizados.",{"path":120,"title":121,"description":122,"icon":13},"\u002Fpt-BR","Introdução ao Pingo Notify","Conecte o WhatsApp aos seus sistemas, automatize fluxos e envie mensagens.",{"path":124,"title":125,"description":126,"icon":60},"\u002Fpt-BR\u002Fintegrations","Integrações","Integrações representam aplicações externas vinculadas ao Pingo Notify, autorizadas a acessar recursos como conexões, planos e mensageria.",{"path":128,"title":129,"description":130,"icon":65},"\u002Fpt-BR\u002Fofficial-whatsapp-api","API Oficial do WhatsApp","Guia passo a passo para solicitar acesso à API Oficial do WhatsApp Business e conectá-la ao Pingo Notify.",{"path":132,"title":133,"description":134,"icon":70},"\u002Fpt-BR\u002Fplugin-wordpress","Primeiros passos","Plugin WordPress que conecta eventos do seu site ao Pingo Notify para envio automático de notificações.",{"path":136,"title":137,"description":138,"icon":75},"\u002Fpt-BR\u002Ftemplate-plugins","Guia de Templates","Aprenda a criar mensagens dinâmicas personalizadas.",{"path":140,"title":16,"description":141,"icon":18},"\u002Fpt-BR\u002Fwebhooks","Receba eventos do WhatsApp em tempo real vinculando webhooks a uma ou mais conexões no Pingo Notify.",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":146},0,24,false,"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M4 5h16M4 12h16M4 19h16\"\u002F>",{"left":143,"top":143,"width":148,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":150},448,512,"\u003Cpath fill=\"currentColor\" d=\"M96 0C43 0 0 43 0 96v320c0 53 43 96 96 96h320c17.7 0 32-14.3 32-32s-14.3-32-32-32v-64c17.7 0 32-14.3 32-32V32c0-17.7-14.3-32-32-32zm0 384h256v64H96c-17.7 0-32-14.3-32-32s14.3-32 32-32m32-240c0-8.8 7.2-16 16-16h192c8.8 0 16 7.2 16 16s-7.2 16-16 16H144c-8.8 0-16-7.2-16-16m16 48h192c8.8 0 16 7.2 16 16s-7.2 16-16 16H144c-8.8 0-16-7.2-16-16s7.2-16 16-16\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":152},"\u003Cpath fill=\"currentColor\" d=\"M224 32H64c-17.7 0-32 14.3-32 32v64c0 17.7 14.3 32 32 32h377.4c4.2 0 8.3-1.7 11.3-4.7l48-48c6.2-6.2 6.2-16.4 0-22.6l-48-48c-3-3-7.1-4.7-11.3-4.7H288c0-17.7-14.3-32-32-32s-32 14.3-32 32m256 224c0-17.7-14.3-32-32-32H288v-32h-64v32H70.6c-4.2 0-8.3 1.7-11.3 4.7l-48 48c-6.2 6.2-6.2 16.4 0 22.6l48 48c3 3 7.1 4.7 11.3 4.7H448c17.7 0 32-14.3 32-32zM288 480v-96h-64v96c0 17.7 14.3 32 32 32s32-14.3 32-32\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":154},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m21 21l-4.34-4.34\"\u002F>\u003Ccircle cx=\"11\" cy=\"11\" r=\"8\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":156},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m5 8l6 6m-7 0l6-6l2-3M2 5h12M7 2h1m14 20l-5-10l-5 10m2-4h6\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":158},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m6 9l6 6l6-6\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":160},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":162},"\u003Cpath fill=\"currentColor\" d=\"M156.6 384.9L125.7 354c-8.5-8.5-11.5-20.8-7.7-32.2c3-8.9 7-20.5 11.8-33.8H24c-8.6 0-16.6-4.6-20.9-12.1s-4.2-16.7.2-24.1l52.5-88.5c13-21.9 36.5-35.3 61.9-35.3H200c2.4-4 4.8-7.7 7.2-11.3C289.1-4.1 411.1-8.1 483.9 5.3c11.6 2.1 20.6 11.2 22.8 22.8c13.4 72.9 9.3 194.8-111.4 276.7c-3.5 2.4-7.3 4.8-11.3 7.2v82.3c0 25.4-13.4 49-35.3 61.9l-88.5 52.5c-7.4 4.4-16.6 4.5-24.1.2S224 496.7 224 488V380.8c-14.1 4.9-26.4 8.9-35.7 11.9c-11.2 3.6-23.4.5-31.8-7.8zM384 168a40 40 0 1 0 0-80a40 40 0 1 0 0 80\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":164},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594zM20 2v4m2-2h-4\"\u002F>\u003Ccircle cx=\"4\" cy=\"20\" r=\"2\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":166},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M3.85 8.62a4 4 0 0 1 4.78-4.77a4 4 0 0 1 6.74 0a4 4 0 0 1 4.78 4.78a4 4 0 0 1 0 6.74a4 4 0 0 1-4.77 4.78a4 4 0 0 1-6.75 0a4 4 0 0 1-4.78-4.77a4 4 0 0 1 0-6.76\"\u002F>\u003Cpath d=\"m9 12l2 2l4-4\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":168},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M11.525 2.295a.53.53 0 0 1 .95 0l2.31 4.679a2.12 2.12 0 0 0 1.595 1.16l5.166.756a.53.53 0 0 1 .294.904l-3.736 3.638a2.12 2.12 0 0 0-.611 1.878l.882 5.14a.53.53 0 0 1-.771.56l-4.618-2.428a2.12 2.12 0 0 0-1.973 0L6.396 21.01a.53.53 0 0 1-.77-.56l.881-5.139a2.12 2.12 0 0 0-.611-1.879L2.16 9.795a.53.53 0 0 1 .294-.906l5.165-.755a2.12 2.12 0 0 0 1.597-1.16z\"\u002F>",{"left":143,"top":143,"width":148,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":170},"\u003Cpath fill=\"currentColor\" d=\"M0 80c0-26.5 21.5-48 48-48h96c26.5 0 48 21.5 48 48v96c0 26.5-21.5 48-48 48H48c-26.5 0-48-21.5-48-48zm64 16v64h64V96zM0 336c0-26.5 21.5-48 48-48h96c26.5 0 48 21.5 48 48v96c0 26.5-21.5 48-48 48H48c-26.5 0-48-21.5-48-48zm64 16v64h64v-64zM304 32h96c26.5 0 48 21.5 48 48v96c0 26.5-21.5 48-48 48h-96c-26.5 0-48-21.5-48-48V80c0-26.5 21.5-48 48-48m80 64h-64v64h64zM256 304c0-8.8 7.2-16 16-16h64c8.8 0 16 7.2 16 16s7.2 16 16 16h32c8.8 0 16-7.2 16-16s7.2-16 16-16s16 7.2 16 16v96c0 8.8-7.2 16-16 16h-64c-8.8 0-16-7.2-16-16s-7.2-16-16-16s-16 7.2-16 16v64c0 8.8-7.2 16-16 16h-32c-8.8 0-16-7.2-16-16zm112 176a16 16 0 1 1 0-32a16 16 0 1 1 0 32m64 0a16 16 0 1 1 0-32a16 16 0 1 1 0 32\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":172},"\u003Cpath fill=\"currentColor\" d=\"M234.5 5.7c13.9-5 29.1-5 43.1 0l192 68.6c25.4 9.1 42.4 33.2 42.4 60.3v242.9c0 27-17 51.2-42.5 60.3l-192 68.6c-13.9 5-29.1 5-43.1 0l-192-68.6C17 428.6 0 404.5 0 377.4V134.6c0-27 17-51.2 42.5-60.3zM256 66L82.3 128L256 190l173.7-62zm32 368.6l160-57.1v-188l-160 57.1z\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":174},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M18 16.98h-5.99c-1.1 0-1.95.94-2.48 1.9A4 4 0 0 1 2 17c.01-.7.2-1.4.57-2\"\u002F>\u003Cpath d=\"m6 17l3.13-5.78c.53-.97.1-2.18-.5-3.1a4 4 0 1 1 6.89-4.06\"\u002F>\u003Cpath d=\"m12 6l3.13 5.73C15.66 12.7 16.9 13 18 13a4 4 0 0 1 0 8\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":176},"\u003Cpath fill=\"currentColor\" d=\"m61.7 169.4l101.5 278C92.2 413 43.3 340.2 43.3 256c0-30.9 6.6-60.1 18.4-86.6m337.9 75.9c0-26.3-9.4-44.5-17.5-58.7c-10.8-17.5-20.9-32.4-20.9-49.9c0-19.6 14.8-37.8 35.7-37.8c.9 0 1.8.1 2.8.2c-37.9-34.7-88.3-55.9-143.7-55.9c-74.3 0-139.7 38.1-177.8 95.9c5 .2 9.7.3 13.7.3c22.2 0 56.7-2.7 56.7-2.7c11.5-.7 12.8 16.2 1.4 17.5c0 0-11.5 1.3-24.3 2l77.5 230.4L249.8 247l-33.1-90.8c-11.5-.7-22.3-2-22.3-2c-11.5-.7-10.1-18.2 1.3-17.5c0 0 35.1 2.7 56 2.7c22.2 0 56.7-2.7 56.7-2.7c11.5-.7 12.8 16.2 1.4 17.5c0 0-11.5 1.3-24.3 2l76.9 228.7l21.2-70.9c9-29.4 16-50.5 16-68.7m-139.9 29.3l-63.8 185.5c19.1 5.6 39.2 8.7 60.1 8.7c24.8 0 48.5-4.3 70.6-12.1c-.6-.9-1.1-1.9-1.5-2.9zm183-120.7c.9 6.8 1.4 14 1.4 21.9c0 21.6-4 45.8-16.2 76.2l-65 187.9C426.2 403 468.7 334.5 468.7 256c0-37-9.4-71.8-26-102.1M504 256c0 136.8-111.3 248-248 248C119.2 504 8 392.7 8 256C8 119.2 119.2 8 256 8c136.7 0 248 111.2 248 248m-11.4 0c0-130.5-106.2-236.6-236.6-236.6C125.5 19.4 19.4 125.5 19.4 256S125.6 492.6 256 492.6c130.5 0 236.6-106.1 236.6-236.6\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":178},"\u003Cpath fill=\"currentColor\" d=\"M48 64C21.5 64 0 85.5 0 112c0 15.1 7.1 29.3 19.2 38.4l217.6 163.2c11.4 8.5 27 8.5 38.4 0l217.6-163.2c12.1-9.1 19.2-23.3 19.2-38.4c0-26.5-21.5-48-48-48zM0 176v208c0 35.3 28.7 64 64 64h384c35.3 0 64-28.7 64-64V176L294.4 339.2a63.9 63.9 0 0 1-76.8 0z\"\u002F>",{"left":143,"top":143,"width":180,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":181},640,"\u003Cpath fill=\"currentColor\" d=\"M392.8 1.2c-17-4.9-34.7 5-39.6 22l-128 448c-4.9 17 5 34.7 22 39.6s34.7-5 39.6-22l128-448c4.9-17-5-34.7-22-39.6m80.6 120.1c-12.5 12.5-12.5 32.8 0 45.3l89.3 89.4l-89.4 89.4c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0l112-112c12.5-12.5 12.5-32.8 0-45.3l-112-112c-12.5-12.5-32.8-12.5-45.3 0zm-306.7 0c-12.5-12.5-32.8-12.5-45.3 0l-112 112c-12.5 12.5-12.5 32.8 0 45.3l112 112c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L77.3 256l89.4-89.4c12.5-12.5 12.5-32.8 0-45.3\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":183},"\u003Cpath fill=\"currentColor\" d=\"M336 352c97.2 0 176-78.8 176-176S433.2 0 336 0S160 78.8 160 176c0 18.7 2.9 36.8 8.3 53.7L7 391c-4.5 4.5-7 10.6-7 17v80c0 13.3 10.7 24 24 24h80c13.3 0 24-10.7 24-24v-40h40c13.3 0 24-10.7 24-24v-40h40c6.4 0 12.5-2.5 17-7l33.3-33.3c16.9 5.4 35 8.3 53.7 8.3m40-256a40 40 0 1 1 0 80a40 40 0 1 1 0-80\"\u002F>",{"id":185,"title":40,"body":186,"description":41,"extension":535,"hidden":145,"icon":8,"meta":536,"navigation":537,"path":39,"seo":538,"stem":539,"__hash__":540},"docs\u002Fen\u002Fapikeys.md",{"type":187,"value":188,"toc":524},"minimark",[189,194,205,219,222,225,229,232,248,251,253,257,272,274,278,288,291,293,297,304,307,321,323,327,334,344,353,386,401,403,407,414,462,469,478,480,484,498,500,504,517,520],[190,191,193],"h2",{"id":192},"what-are-api-keys","What are API Keys?",[195,196,197,200,201,204],"p",{},[198,199,40],"strong",{}," are ",[198,202,203],{},"access keys"," that identify and authorize applications to use Pingo Notify.",[206,207,208],"info",{},[195,209,210,211,214,215,218],{},"Think of API Keys as a ",[198,212,213],{},"special password for systems",",",[216,217],"br",{},"\nnot for people.",[195,220,221],{},"They ensure that only authorized applications can access your account and send messages on your behalf.",[223,224],"hr",{},[190,226,228],{"id":227},"what-are-api-keys-used-for","What are API Keys used for?",[195,230,231],{},"API Keys allow an application to:",[233,234,235,239,242,245],"ul",{},[236,237,238],"li",{},"Access your Pingo Notify account",[236,240,241],{},"Use messaging resources",[236,243,244],{},"Query permitted information",[236,246,247],{},"Perform actions securely",[195,249,250],{},"Without a valid key, access is blocked.",[223,252],{},[190,254,256],{"id":255},"important-to-understand","Important to understand",[258,259,261],"callout",{"icon":260},"circle-info",[233,262,263,266,269],{},[236,264,265],{},"The key identifies your account",[236,267,268],{},"Anyone with the key can use your account",[236,270,271],{},"It must be protected like a password",[223,273],{},[190,275,277],{"id":276},"how-it-works-in-practice","How it works in practice",[206,279,280],{},[195,281,282,283,285],{},"Simple flow:",[216,284],{},[198,286,287],{},"Application → API Key → Pingo Notify",[195,289,290],{},"Whenever an application tries to communicate with Pingo Notify, the API Key is used to validate access.",[223,292],{},[190,294,296],{"id":295},"creating-api-keys","Creating API Keys",[195,298,299,300,303],{},"API Keys are created directly in the Pingo Notify dashboard, or through the API itself with ",[51,301,302],{},"POST \u002Fv3\u002Fapi-tokens",".",[195,305,306],{},"Important points:",[233,308,309,315,318],{},[236,310,311,312],{},"The key is displayed ",[198,313,314],{},"only once",[236,316,317],{},"It cannot be viewed again",[236,319,320],{},"If lost, a new one must be generated",[223,322],{},[190,324,326],{"id":325},"using-your-key","Using your key",[195,328,329,330,333],{},"A key always begins with ",[51,331,332],{},"sk_live_",":",[335,336,341],"pre",{"className":337,"code":339,"language":340},[338],"language-text","sk_live_a1b2c3d4e5f6...\n","text",[51,342,339],{"__ignoreMap":343},"",[195,345,346,347,352],{},"Send it in the ",[198,348,349],{},[51,350,351],{},"apikey"," header on every request:",[335,354,358],{"className":355,"code":356,"language":357,"meta":343,"style":343},"language-bash shiki shiki-themes github-light github-dark","curl https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fconnections \\\n  --header 'apikey: sk_live_a1b2c3d4e5f6...'\n","bash",[51,359,360,377],{"__ignoreMap":343},[361,362,365,369,373],"span",{"class":363,"line":364},"line",1,[361,366,368],{"class":367},"sScJk","curl",[361,370,372],{"class":371},"sZZnC"," https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fconnections",[361,374,376],{"class":375},"sj4cs"," \\\n",[361,378,380,383],{"class":363,"line":379},2,[361,381,382],{"class":375},"  --header",[361,384,385],{"class":371}," 'apikey: sk_live_a1b2c3d4e5f6...'\n",[387,388,389],"warning",{},[195,390,391,392,396,397,400],{},"It is the ",[198,393,394],{},[51,395,351],{}," header — not ",[51,398,399],{},"Authorization: Bearer",". The same key works across every version of the API.",[223,402],{},[190,404,406],{"id":405},"rotating-and-revoking","Rotating and revoking",[195,408,409,410,413],{},"If a key leaks, you do not have to delete it and rebuild your integration. ",[198,411,412],{},"Rotate"," it — the old secret dies the instant the new one is issued, and the replacement comes back in the response:",[335,415,417],{"className":355,"code":416,"language":357,"meta":343,"style":343},"curl -X PATCH https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fapi-tokens\u002F{id} \\\n  --header 'apikey: sk_live_...' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --data '{ \"refreshToken\": true }'\n",[51,418,419,434,443,453],{"__ignoreMap":343},[361,420,421,423,426,429,432],{"class":363,"line":364},[361,422,368],{"class":367},[361,424,425],{"class":375}," -X",[361,427,428],{"class":371}," PATCH",[361,430,431],{"class":371}," https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fapi-tokens\u002F{id}",[361,433,376],{"class":375},[361,435,436,438,441],{"class":363,"line":379},[361,437,382],{"class":375},[361,439,440],{"class":371}," 'apikey: sk_live_...'",[361,442,376],{"class":375},[361,444,446,448,451],{"class":363,"line":445},3,[361,447,382],{"class":375},[361,449,450],{"class":371}," 'Content-Type: application\u002Fjson'",[361,452,376],{"class":375},[361,454,456,459],{"class":363,"line":455},4,[361,457,458],{"class":375},"  --data",[361,460,461],{"class":371}," '{ \"refreshToken\": true }'\n",[195,463,464,465,468],{},"To revoke a key outright, delete it with ",[51,466,467],{},"DELETE \u002Fv3\u002Fapi-tokens\u002F{id}",". It stops working immediately.",[206,470,471],{},[195,472,473,474,477],{},"A key carries the permissions of the person who created it. A key created by an ",[198,475,476],{},"Owner"," can do everything an Owner can — including billing. Create each key under an account whose role matches what the integration actually needs.",[223,479],{},[190,481,483],{"id":482},"security-best-practices","Security best practices",[233,485,486,489,492,495],{},[236,487,488],{},"Do not share your API Key",[236,490,491],{},"Do not publish the key in public places",[236,493,494],{},"Store it securely",[236,496,497],{},"Remove keys that are no longer in use",[223,499],{},[190,501,503],{"id":502},"quick-summary","Quick summary",[206,505,506],{},[233,507,508,511,514],{},[236,509,510],{},"API Keys control access to your account",[236,512,513],{},"They are used by applications, not people",[236,515,516],{},"They must be kept secure",[195,518,519],{},"Whenever an application needs to access Pingo Notify, it will require a valid API Key.",[521,522,523],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":343,"searchDepth":445,"depth":445,"links":525},[526,527,528,529,530,531,532,533,534],{"id":192,"depth":379,"text":193},{"id":227,"depth":379,"text":228},{"id":255,"depth":379,"text":256},{"id":276,"depth":379,"text":277},{"id":295,"depth":379,"text":296},{"id":325,"depth":379,"text":326},{"id":405,"depth":379,"text":406},{"id":482,"depth":379,"text":483},{"id":502,"depth":379,"text":503},"md",{},true,{"title":40,"description":41},"en\u002Fapikeys","-DF1DHKOG59ZAiamqufgm4TL7h-okwkcB4Qz6b3VtMc",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":542},"\u003Cpath fill=\"currentColor\" d=\"M256 32c14.2 0 27.3 7.5 34.5 19.8l216 368c7.3 12.4 7.3 27.7.2 40.1S486.3 480 472 480H40c-14.3 0-27.6-7.7-34.7-20.1s-7-27.8.2-40.1l216-368C228.7 39.5 241.8 32 256 32m0 128c-13.3 0-24 10.7-24 24v112c0 13.3 10.7 24 24 24s24-10.7 24-24V184c0-13.3-10.7-24-24-24m32 224a32 32 0 1 0-64 0a32 32 0 1 0 64 0\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":544},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"14\" height=\"14\" x=\"8\" y=\"8\" rx=\"2\" ry=\"2\"\u002F>\u003Cpath d=\"M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":546},"\u003Cpath fill=\"currentColor\" d=\"M256 512a256 256 0 1 0 0-512a256 256 0 1 0 0 512m-40-176h24v-64h-24c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24h-80c-13.3 0-24-10.7-24-24s10.7-24 24-24m40-208a32 32 0 1 1 0 64a32 32 0 1 1 0-64\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":548},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m15 18l-6-6l6-6\"\u002F>",1787698190948]