Zum Inhalt springen

Catálogo de eventos da plataforma (webhooks)

GET/api/integrations/events

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.

Público, sem login e sem `X-CommunityId`. Os 13 eventos da v1 e o `ping`, cada um com nome (`type`), família (o escopo, o que vem antes do ponto), versão (`1` em todos na v1), descrição no idioma de quem chama e o JSON Schema de `data` (`additionalProperties: false`: campo que não está no esquema nunca sai).

Envelope de toda entrega: `{ id, type, version, occurredAt, community: { id, slug }, data }`. Todo evento de pessoa traz o bloco `member`: `id`, `name`, `email`, `phone` (E.164, como `+5541999998888`, ou `null`) e `phoneCountry` (ISO 3166-1 alfa-2, como `BR`, ou `null`), igual para todo destino. Valores em centavos (`{ amount, currency }`), sempre o que quem comprou pagou. Nunca vão: taxa, valor líquido, custo de provedor, id do processador, CPF/CNPJ, endereço, data de nascimento, campos personalizados, dado de cartão, senha, hash ou token.

O ciclo de vida de cada família, com `member` = quem fez a ação e só sobre item publicado (aprovado, fora de rascunho). Downloads: `download.item_published`, `download.item_updated` (`changed`: `title`, `details`, `cover`), `download.item_moved` (`categoryId`, `previousCategoryId`), `download.file_added`, `download.file_replaced` (`version`), `download.file_removed`, `download.item_deleted`, `download.category_created`. Posts: `post.updated`, `post.moved` (`previousSpaceId`), `post.deleted`. `comment.deleted`, `reaction.removed`. Eventos: `event.created`, `event.updated`, `event.rescheduled` (`previousStartsAt`), `event.deleted` (apagar é o cancelamento de hoje), `event.stream_started`, `event.recording_published`. Cursos: `course.published`, `course.updated`, `lesson.published`, `course.left`. Espaços: `space.created`, `space.updated`, `space.deleted` (`module`). Formulários: `form.published`, `form.closed`, `form.reopened`. Nunca o texto de post ou comentário, a descrição, o nome do arquivo ou o link.

Antworten

StatusBeschreibung
200O catálogo.

curl-Beispiel

curl -X GET "https://api.memberfy.net/api/integrations/events"