Webhooks do workspace

cURL

curl --request GET \
  --url https://api.wabox.me/partner/webhooks \
  --header 'Partner-Token: <api-key>'

const options = {method: 'GET', headers: {'Partner-Token': '<api-key>'}};

fetch('https://api.wabox.me/partner/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.wabox.me/partner/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 => [
    "Partner-Token: <api-key>"
  ],
]);

$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.wabox.me/partner/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Partner-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "received_url": null,
  "delivery_url": null,
  "message_status_url": null,
  "connected_url": null,
  "disconnected_url": null,
  "chat_presence_url": null,
  "single_url_enabled": true,
  "single_url": "https://kinbox.example/wabox/events",
  "notify_sent_by_me": true,
  "ignore_groups": false,
  "ignore_private": false,
  "ignore_text": false,
  "ignore_image": false,
  "ignore_video": false,
  "ignore_audio": false,
  "ignore_document": false,
  "ignore_received_callback": false,
  "ignore_delivery_callback": false,
  "ignore_message_status_callback": false,
  "ignore_connected_callback": false,
  "ignore_disconnected_callback": false,
  "ignore_chat_presence_callback": true,
  "secret": "whsec_4b1d9e8f7a6c5d4e3f2a1b0c9d8e7f6a",
  "configured": true,
  "used_by_instances": 42
}

{
  "error": {
    "code": "partner_token_required",
    "message": "Invalid Partner-Token"
  }
}

GET

partner

webhooks

cURL

curl --request GET \
  --url https://api.wabox.me/partner/webhooks \
  --header 'Partner-Token: <api-key>'

const options = {method: 'GET', headers: {'Partner-Token': '<api-key>'}};

fetch('https://api.wabox.me/partner/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.wabox.me/partner/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 => [
    "Partner-Token: <api-key>"
  ],
]);

$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.wabox.me/partner/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Partner-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "received_url": null,
  "delivery_url": null,
  "message_status_url": null,
  "connected_url": null,
  "disconnected_url": null,
  "chat_presence_url": null,
  "single_url_enabled": true,
  "single_url": "https://kinbox.example/wabox/events",
  "notify_sent_by_me": true,
  "ignore_groups": false,
  "ignore_private": false,
  "ignore_text": false,
  "ignore_image": false,
  "ignore_video": false,
  "ignore_audio": false,
  "ignore_document": false,
  "ignore_received_callback": false,
  "ignore_delivery_callback": false,
  "ignore_message_status_callback": false,
  "ignore_connected_callback": false,
  "ignore_disconnected_callback": false,
  "ignore_chat_presence_callback": true,
  "secret": "whsec_4b1d9e8f7a6c5d4e3f2a1b0c9d8e7f6a",
  "configured": true,
  "used_by_instances": 42
}

{
  "error": {
    "code": "partner_token_required",
    "message": "Invalid Partner-Token"
  }
}

Authorizations

Partner-Token

string

header

required

Credencial da Partner API (workspace › Segurança › Partner API). Só nas rotas /partner/*.

Response

Configuração do workspace.

received_url

string | null

required