Zum Inhalt springen

Pede um e-mail de integração a owner e admin (serviço)

POST/api/internal/integrations/notify

Auth
Öffentlich
API-Schlüssel:
Kein API-Schlüssel möglich
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

**Rota de serviço, só para o `memberfy-developers`**. Autenticada pelo segredo de serviço no cabeçalho `X-Service-Token` (`DEVELOPERS_SERVICE_TOKEN`, comparado em tempo constante); sessão e chave de API não servem. Limite de 60 chamadas por minuto por IP.

O corpo aceita **só** `{ communityId, kind, params }`. A API escolhe os destinatários (owner e admin vivos da comunidade, cada um no seu idioma), o template e a marca: destinatário, assunto ou HTML vindos de fora são recusados com 422, como qualquer campo fora do contrato.

| `kind` | `params` | |---|---| | `endpoint_disabled` | `endpointUrl` (obrigatório, já mascarada), `endpointName`, `failures`, `hours` | | `fixed_ip_quota` | `usedPercent` (obrigatório), `limit` | | `app_disabled` | `appName` (obrigatório), `failures`, `hours` — integração pronta (Discord, Slack…) desligada por falha; o botão leva a Configurações › Integrações & APIs › Integrações |

Header

NameTypBeschreibung
X-Service-TokenPflichtstring

Request-Body application/json

NameTypBeschreibung
communityIdPflichtstring (uuid)
kindPflichtendpoint_disabled | fixed_ip_quota | app_disabled | app_needs_attention`app_needs_attention` (`{ appName, reason: channel_gone }`): só para owners, e-mail de sistema que nenhuma preferência bloqueia.
paramsoptionalobject

Antworten

StatusBeschreibung
202E-mails enfileirados.
401Sem o segredo de serviço
404Comunidade não encontrada.
422`kind` desconhecido, campo fora do contrato ou `params` inválido.
429Limite de chamadas atingido.

curl-Beispiel

curl -X POST "https://api.memberfy.net/api/internal/integrations/notify" \
  -H "Content-Type: application/json" \
  -d '{"communityId":"00000000-0000-0000-0000-000000000000","kind":"endpoint_disabled"}'