WebHook

Modelo WebHook

{
    "id": 1,
    "name": "payments_report_stripe",
    "enabled": true,
    "method": "POST",
    "url": "https://lukaapi.payco.net.ve/api/v1/transaccion/stripe.registrar",
    "headers": [],
    "body": {
        "Monto": "e2:total_e2",
        "CodigoAutorizacion": "v:metadata.payload.identifier",
        "Email": "v:client.email",
        "Nombre": "v:client.name",
        "RespuestaTransaccion": "v:metadata.payload.api_response.gateway_payload",
        "RespuestaError": "v:metadata.payload.api_response.gateway_error"
    },
    "auth": {
        "type": "basic",
        "username": "liveri_vz_admin",
        "password": "pascal odd scowl enlist"
    },
    "created_at": "2020-08-09 18:24:00",
    "updated_at": "2020-08-09 18:24:00",
    "company_id": null,
    "branch_id": null,
    "config": [],
    "branch_group_id": null
}

Insertar WebHook

Método URI Cabeceras
POST /web-hooks Authorization 
{
    "name": "required|string|in:goods_import,payments_validation_zelle,payments_report_stripe",
    "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,payments_validation_zelle,payments_report_stripe",
    "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

Handle

Método URI Cabeceras
POST /web-hooks/{handler}/{hookName} N/A

Enlaces de WebHook