Create Widget - Plugixa Chat

POST /plugixa-chat/v1/widgets

Create a widget, with its appearance, channels and targeting rules in one request.

The signed-in user needs the plugixa_chat_create capability. Administrators have it.

Note. name is only checked when you send it. A request that leaves it out creates a widget with an empty name.

Request

POST https://your-site.example/wp-json/plugixa-chat/v1/widgets

Request body

Content type: application/json

A widget is created with a complete appearance even when you send none. Saving clears the plugin’s cached widget data, so the next page served picks up the change (a full-page cache may need purging too).

Appearance

Every key is optional. A value out of range is brought into range, and an unknown value falls back to the default.

Channels

Each row of channels:

Rules

Each row of rules:

Rows that are dropped are left out silently: compare the response with what you sent. ab is written by Pro’s A/B tests; do not write it yourself.

{
  "name": "Main widget",
  "status": "active",
  "appearance": {
    "position": "right",
    "size": 56,
    "color": "#0f766e"
  },
  "channels": [
    {
      "slug": "whatsapp",
      "value": "+15550001234",
      "message": "Hi! I'm on {title}",
      "is_active": true
    }
  ],
  "rules": [
    {
      "kind": "url",
      "mode": "hide",
      "operator": "contains",
      "values": [
        "/checkout"
      ]
    }
  ]
}

Responses

201 Created. data is the new widget.

{
  "success": true,
  "data": {
    "id": 2,
    "name": "Main widget",
    "status": "active",
    "appearance": {
      "position": "right",
      "layout": "vertical",
      "animation": "none",
      "trigger": "click",
      "size": 56,
      "offset_x": 24,
      "offset_y": 24,
      "color": "#0f766e",
      "icon_color": "#ffffff",
      "cta": "",
      "label": "",
      "icon": null,
      "badge": 0,
      "show_delay": 0,
      "show_scroll": 0,
      "show_exit": false
    },
    "sort_order": 0,
    "deleted_at": null,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:30:00",
    "created_by": "1",
    "modified_by": "1",
    "channels": [
      {
        "id": 31,
        "widget_id": 2,
        "slug": "whatsapp",
        "label": "",
        "value": "+15550001234",
        "message": "Hi! I'm on {title}",
        "is_active": true,
        "sort_order": 0,
        "deleted_at": null,
        "created_at": "2026-11-12 09:30:00",
        "modified_at": "2026-11-12 09:30:00",
        "created_by": "1",
        "modified_by": "1",
        "color": "#25d366",
        "new_tab": false,
        "devices": "all",
        "icon": null,
        "hover": "",
        "qr": false,
        "settings": []
      }
    ],
    "rules": [
      {
        "id": 8,
        "widget_id": 2,
        "kind": "url",
        "mode": "hide",
        "operator": "contains",
        "value": "[\"\\/checkout\"]",
        "sort_order": "0",
        "deleted_at": null,
        "created_at": "2026-11-12 09:30:00",
        "modified_at": "2026-11-12 09:30:00",
        "created_by": "1",
        "modified_by": "1",
        "values": [
          "/checkout"
        ]
      }
    ],
    "channel_count": 1
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-chat/v1/widgets" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name":"Main widget","status":"active","appearance":{"position":"right","size":56,"color":"#0f766e"},"channels":[{"slug":"whatsapp","value":"+15550001234","message":"Hi! I'm on {title}","is_active":true}],"rules":[{"kind":"url","mode":"hide","operator":"contains","values":["/checkout"]}]}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chat/v1/widgets');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'name'       => 'Main widget',
        'status'     => 'active',
        'appearance' => [
            'position' => 'right',
            'size'     => 56,
            'color'    => '#0f766e',
        ],
        'channels'   => [
            [
                'slug'      => 'whatsapp',
                'value'     => '+15550001234',
                'message'   => 'Hi! I\'m on {title}',
                'is_active' => true,
            ],
        ],
        'rules'      => [
            [
                'kind'     => 'url',
                'mode'     => 'hide',
                'operator' => 'contains',
                'values'   => ['/checkout'],
            ],
        ],
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-chat/v1/widgets', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Main widget', status: 'active', appearance: { position: 'right', size: 56, color: '#0f766e' }, channels: [{ slug: 'whatsapp', value: '+15550001234', message: 'Hi! I\'m on {title}', is_active: true }], rules: [{ kind: 'url', mode: 'hide', operator: 'contains', values: ['/checkout'] }] }),
});
const { data } = await response.json();