Visão geral

API do Notyfacil v1

Publique eventos e deixe a entrega com a gente: fan-out, assinatura HMAC, retries com backoff, histórico por tentativa e replay. A mesma API cuida do recebimento, que recebe webhooks de provedores externos por você e os repassa.

Toda requisição a /v1 leva uma chave de API no Authorization. As respostas de erro com corpo vêm em application/problem+json, com o motivo em title.

Informações

• Versão do OpenAPI: 3.1.1

Operações

GET

/v1/events

POST

/v1/events

GET

/v1/events/{id}

GET

/v1/events/{id}/deliveries

POST

/v1/events/{id}/replay

GET

/v1/deliveries/{id}/attempts

POST

/v1/deliveries/{id}/retry

GET

/v1/consumers

POST

/v1/consumers

GET

/v1/event-types

POST

/v1/event-types

GET

/v1/endpoints

POST

/v1/endpoints

GET

/v1/endpoints/{id}

PATCH

/v1/endpoints/{id}

POST

/v1/endpoints/{id}/test

POST

/v1/endpoints/{id}/rotate-secret

PUT

/v1/endpoints/{id}/headers

GET

/v1/ingest/providers

GET

/v1/ingest/sources

POST

/v1/ingest/sources

GET

/v1/ingest/sources/{id}

DELETE

/v1/ingest/sources/{id}

PATCH

/v1/ingest/sources/{id}

PUT

/v1/ingest/sources/{id}/secret

POST

/v1/ingest/sources/{id}/rotate-token

GET

/v1/ingest/sources/{id}/messages

GET

/v1/ingest/sources/{id}/destinations

POST

/v1/ingest/sources/{id}/destinations

DELETE

/v1/ingest/destinations/{id}

PATCH

/v1/ingest/destinations/{id}

POST

/v1/ingest/destinations/{id}/rotate-secret

GET

/v1/ingest/messages/{id}

GET

/v1/ingest/messages/{id}/deliveries

POST

/v1/ingest/messages/{id}/replay

POST

/in/{token}

Autenticação

Bearer

Uma chave por ambiente: whk_live_ é produção, whk_test_ é desenvolvimento, e os dois têm dados separados. A chave é de servidor e não vai para navegador nem aplicativo: quem a tem publica eventos e lê o histórico do ambiente.

Tipo de esquema de segurança: http

Formato do bearer: whk_live_… ou whk_test_…