WebHook

Maneja los procesos de comunicación de Servidor a Servidor, como integraciones de terceros. Puede ver más detalles de formato para los distintos tipos de WebHook Aquí

Estructura de Datos

Atributo Tipo Descripción
id int
name string
enabled bool
method string
url string
headers array
body array
auth array
created_at datetime\|null
updated_at datetime\|null
company_id int\|null
branch_id int\|null
config array
branch_group_id int\|null
display_name string\|null
config_auto_sync bool\|null
config_auto_sync_delay int\|null
config_auto_sync_offset int
config_backoff array\|null
config_check_in_service bool\|null
config_conditions array\|null
config_ext string
config_order_status_mask int\|null
config_response_processor_handler string\|null
config_response_processor_hook string\|null
config_tries int\|null
config_ttl int\|null
config_use_body bool\|null
good_import_branch_id int\|null
good_import_clear_missing bool\|null
good_import_currency string\|null
good_import_data_accessor string\|null
good_import_debug bool\|null
good_import_header_identifiers array\|null
good_import_latest_unique_key string\|null
good_import_quantity_reservation int\|null
good_import_quantity_threshold int\|null
good_import_refresh_category bool\|null
good_import_refresh_data bool\|null
good_import_separated_sku bool\|null
good_import_starting_cell string\|null
import_config GoodImportOptions
allLogs ApiLog>
logs ApiLog> 
{
    "id": 1,
    "name": "payments_validation_zelle",
    "enabled": false,
    "method": "POST",
    "url": "https://bspaycoapi-qa.payco.net.ve/api/v1/transaccion/zelle.registrar",
    "headers": [],
    "body": {
        "Monto": "e2:total_e2",
        "CodigoAutorizacion": "v:metadata.payload.identifier",
        "Email": "v:metadata.payload.email",
        "NombrePagador": "v:client.name",
        "Fecha": "datef2:updated_at"
    },
    "auth": {
        "type": "basic",
        "username": "liveri_vz_admin",
        "password": "12345678"
    },
    "created_at": "2020-07-21 22:21:39",
    "updated_at": "2025-10-08 13:59:47",
    "company_id": null,
    "branch_id": null,
    "config": {
        "response_processor": {
            "handler": "payco",
            "hook_name": "zelle-validate"
        }
    },
    "branch_group_id": null,
    "display_name": "Pagos Payco Zelle"
}

Endpoints

Insertar WebHook

Método URI Cabeceras
POST /web-hooks Authorization 
{
    "name": "required|string|in:goods_import,order_status_report,payments_validation_zelle,payments_report_stripe,fleet_prices_ridery,fleet_prices_partner,shipment_creation_ridery,shipment_creation_partner,order_creation_ridery,order_creation_partner,promos_sync,discounts_refresh",
    "display_name": "required|string|max:64",
    "enabled": "boolean",
    "method": "string|in:GET,POST,PATCH,UPDATE",
    "url": "required|string|url",
    "headers": [
        "string"
    ],
    "body": "array",
    "config": "array",
    "auth": {
        "type": "string|in:none,basic,jwt"
    },
    "company_id": "integer",
    "branch_id": "integer",
    "branch_group_id": "integer"
}

Listar WebHook

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /web-hooks Authorization

Mostrar WebHook

{info} Soporta: Carga dinámica

Método URI Cabeceras
GET /web-hooks/{webHookId} Authorization

Actualizar WebHook

Método URI Cabeceras
PATCH /web-hooks/{webHookId} Authorization 
{
    "name": "string|in:goods_import,order_status_report,payments_validation_zelle,payments_report_stripe,fleet_prices_ridery,fleet_prices_partner,shipment_creation_ridery,shipment_creation_partner,order_creation_ridery,order_creation_partner,promos_sync,discounts_refresh",
    "display_name": "required|string|max:64",
    "enabled": "boolean",
    "method": "string|in:GET,POST,PATCH,UPDATE",
    "url": "string|url",
    "headers": [
        "string"
    ],
    "body": "array",
    "config": "array",
    "auth": {
        "type": "string|in:none,basic,jwt"
    },
    "company_id": "integer",
    "branch_id": "integer",
    "branch_group_id": "integer"
}

Eliminar WebHook

Método URI Cabeceras
DELETE /web-hooks/{webHookId} Authorization

Acciones de WebHook

Index Options

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /web-hooks/options Authorization

Trigger

Método URI Cabeceras
POST /web-hooks/{webHookId}/trigger Authorization

Handle

Método URI Cabeceras
POST /web-hooks/{webHookId}/handle Authorization

Check

{info} Soporta: Carga dinámica

Método URI Cabeceras
POST /orders/authorize N/A 
{
    "code": {
        "required": true,
        "string": true,
        "min": "8",
        "regex": "/docs/3/web_hook#^\d+\|[0-9a-f]+$#"
    },
    "is_allowed": "nullable|boolean"
}

Check

{info} Soporta: Carga dinámica

Método URI Cabeceras
GET /orders/authorize N/A 
{
    "code": {
        "required": true,
        "string": true,
        "min": "8",
        "regex": "/docs/3/web_hook#^\d+\|[0-9a-f]+$#"
    },
    "is_allowed": "nullable|boolean"
}

Relaciones