Contents
On this page

Get Webhook - Plugixa Chat

GET /plugixa-chat/v1/webhooks/{id}

Read one webhook, with how its last delivery went.

Needs Plugixa Chat Pro. The signed-in user needs the plugixa_chat_view capability. Administrators have it.

Request

GET https://your-site.example/wp-json/plugixa-chat/v1/webhooks/3

Path parameters

Name Type Description
id integer The webhook’s id

Responses

200 OK. data is the webhook.

{
  "success": true,
  "data": {
    "id": 3,
    "name": "Zapier",
    "url": "https://hooks.zapier.com/hooks/catch/123/abc/",
    "events": [
      "lead.created"
    ],
    "is_active": true,
    "last_status": 200,
    "last_error": "",
    "last_sent_at": "2026-11-12 10:31:00",
    "failures": 0,
    "deleted_at": null,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:31:00",
    "created_by": "1",
    "modified_by": "1"
  }
}
Field Type Meaning
data.id integer The webhook’s id
data.url string Where deliveries are posted
data.events array The events it receives. Only lead.created exists in 1.0.0
data.is_active boolean Whether deliveries are sent
data.last_status integer HTTP status of the last delivery or test, 0 before the first or when the request failed
data.last_error string Why the last one failed, empty when it worked
data.last_sent_at string|null When the last one was sent, in the site’s timezone (not UTC), or null
data.failures integer Failures in a row since the last success
data.created_at string UTC datetime

Errors

Status Code When
404 plugixa_chat_not_found No webhook has this id, or it is in the trash.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-chat/v1/webhooks/3" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chat/v1/webhooks/3');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-chat/v1/webhooks/3', {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();

Quick Links

Share