Caibo PayDocs
Panel

Update, pause or resume a webhook endpoint

PATCH
/v1/webhook-endpoints/{id}

Autorización

apiKey
headerAuthorizationBearer <clave>

Your secret API key, sent as Authorization: Bearer <key>. A key names its environment: psp_test_… works only against sandbox (https://api-sandbox.caibopay.app), psp_live_… only against live (https://api.caibopay.app). Keys are issued by Caibo when your account is opened; the dashboard (Developers) shows the key in use.

Parámetros de ruta

id*string

Cuerpo de la solicitud

application/json
  1. body
active?boolean

False pauses the endpoint; true resumes it.

description?string

A note.

event_types?array<>
url?string
Formatouri

Cuerpo de la respuesta

OK

application/json
  1. response
created_at*string

When it was created.

Formatodate-time
description?string

A note.

event_types*array<>
id*string

The id of the webhook endpoint.

Match^we_[0-9a-z]+$
previous_secret_expires_at?string

Until when the previous secret also signs.

Formatodate-time
secret?string

The signing secret. Present only when the endpoint is created or its secret rotated.

status*string

active: deliveries are sent. paused: you paused it. failing: deliveries keep failing and the endpoint is only probed.

Valor en"active""paused""failing"
url*string

The URL.

Ejemplo de solicitud
curl -X PATCH 'https://api-sandbox.caibopay.app/v1/webhook-endpoints/string' \  -H 'Content-Type: application/json' \  -d '{}'
Ejemplo de respuesta
{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "event_types": [    "beneficiary.created"  ],  "id": "string",  "previous_secret_expires_at": "2019-08-24T14:15:22Z",  "secret": "string",  "status": "active",  "url": "string"}