Skip to main content
GET
/
v2
/
register
/
companies
/
webhooks
Query
curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.sandbox.wepayout.com.br/v2/register/companies/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.sandbox.wepayout.com.br/v2/register/companies/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.sandbox.wepayout.com.br/v2/register/companies/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.sandbox.wepayout.com.br/v2/register/companies/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.sandbox.wepayout.com.br/v2/register/companies/webhooks")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/register/companies/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
[
  {
    "event": "onboarding",
    "url": "https://my-url.requestcatcher.com/test"
  }
]

​
Query

This endpoint allows querying the registered webhook URLs. Filtering can only be done using the event field.
  • If the event parameter is provided, only the webhooks related to that event will be returned
  • If no filter is provided, all registered webhooks will be returned

​
Query Parameters

​
event
string
Get a list of webhooks for a specific event type. Currently, only the onboarding event is supported.Allowed values: onboarding

​
Response

Returns an array of webhook objects.
​
array
array
Array of webhook objects

​
Request Example

curl --request GET \
  --url 'https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {token}'

const response = await fetch('https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks'
headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN'
}

response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "event": "onboarding",
    "url": "https://my-url.requestcatcher.com/test"
  }
]