Listar webhooks.
curl --request GET \
--url https://api.parcelemais.com.br/integration/v1/webhooks \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.parcelemais.com.br/integration/v1/webhooks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.parcelemais.com.br/integration/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parcelemais.com.br/integration/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.parcelemais.com.br/integration/v1/webhooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.parcelemais.com.br/integration/v1/webhooks")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parcelemais.com.br/integration/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"tipo": 3,
"url": "https://parceiro.exemplo.com/webhooks/pedidos",
"tipoAutenticacao": 3
}
]Webhooks
Listar webhooks
Retorna os webhooks cadastrados pelo parceiro, como uma lista simples (sem paginação — um parceiro tem no máximo 3 webhooks, um por tipo: Cliente, Simulação, Pedido). As credenciais de autenticação nunca são retornadas. Configurações de Cliente e Simulação podem aparecer na lista, embora esses fluxos ainda não realizem disparos.
GET
/
v1
/
webhooks
Listar webhooks.
curl --request GET \
--url https://api.parcelemais.com.br/integration/v1/webhooks \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.parcelemais.com.br/integration/v1/webhooks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.parcelemais.com.br/integration/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parcelemais.com.br/integration/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.parcelemais.com.br/integration/v1/webhooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.parcelemais.com.br/integration/v1/webhooks")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parcelemais.com.br/integration/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"tipo": 3,
"url": "https://parceiro.exemplo.com/webhooks/pedidos",
"tipoAutenticacao": 3
}
]Retorna a lista de webhooks cadastrados pelo parceiro identificado automaticamente pelo token — sem paginação, já que um parceiro tem no máximo 3 webhooks (um por tipo).
Tipos de webhook
| Valor | Tipo | Disponibilidade |
|---|---|---|
1 | Cliente | 🟡 Em roadmap — pode ser cadastrado, mas ainda não envia notificações. |
2 | Simulação | 🟡 Em roadmap — pode ser cadastrado, mas ainda não envia notificações. |
3 | Pedido | 🟢 Disponível — envia notificações para os eventos de pedido suportados. |
Os tipos Cliente (
1) e Simulação (2) podem aparecer na listagem, mas ainda não enviam notificações. Atualmente, apenas o tipo Pedido (3) está disponível para os eventos suportados.Tipos de autenticação
| Valor | Significado |
|---|---|
1 | Nenhuma — a requisição é enviada sem credencial de autenticação. |
2 | Basic — utiliza a credencial informada para autenticação HTTP Basic. |
3 | JWT — utiliza a credencial informada como token Bearer JWT. |
Por segurança, as credenciais de autenticação nunca são retornadas por este endpoint.
Authorizations
Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação