Inscrição

POST /hooks

HTTP

POST /hooks HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json

Params

Campo	Tipo	Descrição	Obrigatório
events	[string]	Eventos que deseja receber	✓
endpoint	string	Sua URL de callback para receber os eventos	✓
status	ATIVO ou INATIVO	Define se vai receber os eventos ou não	✓

Requisição

BODY

{
    "events": [
        "ALTERAÇÃO_STATUS"
    ],
    "endpoint": "https://mydomain.com.br/callback",
    "status": "ATIVO"
}

Resposta

200

{
    "document": [],
    "data": {
        "createdAt": "2024-09-10T11:24:54.267Z",
        "endpoint": "https://mydomain.com.br/callback",
        "events": [
            "ALTERAÇÃO_STATUS"
        ],
        "secret": "43a9953827143abd5ab5ddd51acbcb83",
        "updatedAt": "2024-09-10T11:24:54.267Z",
        "uuid": "CA61D228-D987-451B-9035-1A6330BC725C",
        "status": "ATIVO"
    },
    "message": "Inscrição realizada com sucesso",
    "status": "success",
    "rowsAffected": [
        1,
        2
    ]
}

Errors

Código	Referência	Explicação
400	BAD REQUEST	O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401	UNAUTHORIZED	O servidor não autorizou a requisição. Access Token inválido.
403	FORBIDDEN	O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404	NOT FOUND	O servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422	UNPROCESSABLE ENTITY	O servidor não conseguiu processar as informações contidas na requisição.