WebHook

Modelo WebHook

{
    "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": "2021-03-29 16:37:33",
    "company_id": null,
    "branch_id": null,
    "config": {
        "response_processor": {
            "handler": "payco",
            "hook_name": "zelle-validate"
        }
    },
    "branch_group_id": null,
    "display_name": "payments_validation_zelle 1"
}
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 -
config array -
display_name string\|null -

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

Trigger

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

Check

{info} Soporta: Carga dinámica

Método URI Cabeceras
POST /orders/authorize N/A

Check

{info} Soporta: Carga dinámica

Método URI Cabeceras
GET /orders/authorize N/A

Enlaces de WebHook