Registrar webhook

POST

/v1/webhook-endpoints

curl --request POST \
  --url https://api.chaski.ec/v1/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "invoice.authorized" ], "description": "example" }'

El secreto de firma se devuelve solo en esta respuesta. Si la cuenta llegó al límite de su plan: 403 plan_limit_reached (con limit, current y addon_offer).

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

url

required

string

<= 2048 characters

events

required

Array<string>

>= 1 items

Allowed values: invoice.authorized invoice.rejected invoice.failed invoice.voided credit_note.authorized credit_note.rejected credit_note.failed withholding.authorized withholding.rejected withholding.failed delivery_guide.authorized delivery_guide.rejected delivery_guide.failed purchase_settlement.authorized purchase_settlement.rejected purchase_settlement.failed debit_note.authorized debit_note.rejected debit_note.failed document.email_bounced export.ready export.failed certificate.expiring issuer.live_enabled usage.threshold_reached

description

string

<= 200 characters

Responses

201

OK

Media typeapplication/json

object

id

required

string

url

required

string

description

required

string | null

events

required

Array<string>

enabled

required

boolean

environment

required

string

Allowed values: test live

created_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

secret

Solo en la respuesta de creación. Guárdalo: no se vuelve a mostrar.

string

Example

{
  "id": "we_01jbx3k9q2f8m4tn6vwz0yh5ce",
  "environment": "test"
}

400

Petición inválida

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

401

Falta la API key o no es válida

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

403

Sin permiso (cuenta suspendida, emisor no habilitado en producción, límite del plan…)

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

422

No se puede procesar (certificado vencido, Idempotency-Key reutilizada…)

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

429

Demasiadas peticiones

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}