KilaSifen Docs

Webhooks

GET/v1/emitters/{emitter_id}/webhook-deliveries/{delivery_id}

Scope: tenant:read (también platform:admin).

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Path Parameters

emitter_id*Emitter Id
delivery_id*Delivery Id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/emitters/string/webhook-deliveries/string"
{  "correlation_id": "string",  "data": {    "delivery": {      "attempt_number": 0,      "created_at": "2019-08-24T14:15:22Z",      "event_type": "string",      "final_status": "string",      "id": "string",      "payload_snapshot": {},      "request_at": "2019-08-24T14:15:22Z",      "request_body": "string",      "response_body_snapshot": "string",      "response_code": 0,      "updated_at": "2019-08-24T14:15:22Z",      "webhook_endpoint_id": "string"    },    "job": {      "attempts": 0,      "created_at": "2019-08-24T14:15:22Z",      "emitter_id": "string",      "error_snapshot": {},      "finished_at": "2019-08-24T14:15:22Z",      "id": "string",      "job_type": "string",      "related_entity_id": "string",      "related_entity_type": "string",      "scheduled_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "status": "string",      "updated_at": "2019-08-24T14:15:22Z",      "worker_correlation_id": "string"    }  }}
GET/v1/emitters/{emitter_id}/webhooks

Scope: tenant:read (también platform:admin).

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Path Parameters

emitter_id*Emitter Id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/emitters/string/webhooks"
{  "correlation_id": "string",  "data": {    "webhook_endpoints": [      {        "created_at": "2019-08-24T14:15:22Z",        "emitter_id": "string",        "event_subscriptions": [          "string"        ],        "id": "string",        "is_active": true,        "retry_policy": {},        "secret_configured": true,        "updated_at": "2019-08-24T14:15:22Z",        "url": "string"      }    ]  }}
POST/v1/emitters/{emitter_id}/webhooks

Scope: tenant:write (también platform:admin).

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Path Parameters

emitter_id*Emitter Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Alta de un endpoint de webhook.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/emitters/string/webhooks" \  -H "Content-Type: application/json" \  -d '{    "secret": "stringstringstringstringstringst",    "url": "http://example.com"  }'
{  "correlation_id": "string",  "data": {    "webhook_endpoint": {      "created_at": "2019-08-24T14:15:22Z",      "emitter_id": "string",      "event_subscriptions": [        "string"      ],      "id": "string",      "is_active": true,      "retry_policy": {},      "secret_configured": true,      "updated_at": "2019-08-24T14:15:22Z",      "url": "string"    }  }}
PATCH/v1/emitters/{emitter_id}/webhooks/{endpoint_id}

Scope: tenant:write (también platform:admin).

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Path Parameters

emitter_id*Emitter Id
endpoint_id*Endpoint Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Cambios de un endpoint; los campos omitidos no cambian.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/emitters/string/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "correlation_id": "string",  "data": {    "webhook_endpoint": {      "created_at": "2019-08-24T14:15:22Z",      "emitter_id": "string",      "event_subscriptions": [        "string"      ],      "id": "string",      "is_active": true,      "retry_policy": {},      "secret_configured": true,      "updated_at": "2019-08-24T14:15:22Z",      "url": "string"    }  }}
POST/v1/emitters/{emitter_id}/webhooks/{endpoint_id}/deliveries/replay

Reenvía a este endpoint un evento que KilaSifen ya generó para el emisor, identificado por delivery_id. No acepta tipo de evento ni payload del caller, y el endpoint tiene que estar suscripto al tipo del evento (409 webhooks.event_not_subscribed).

Scope: tenant:write (también platform:admin).

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Path Parameters

emitter_id*Emitter Id
endpoint_id*Endpoint Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Reenvío de una entrega existente; el contenido nunca lo arma el caller.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/emitters/string/webhooks/string/deliveries/replay" \  -H "Content-Type: application/json" \  -d '{    "delivery_id": "string"  }'
{  "correlation_id": "string",  "data": {    "delivery": {      "attempt_number": 0,      "created_at": "2019-08-24T14:15:22Z",      "event_type": "string",      "final_status": "string",      "id": "string",      "payload_snapshot": {},      "request_at": "2019-08-24T14:15:22Z",      "request_body": "string",      "response_body_snapshot": "string",      "response_code": 0,      "updated_at": "2019-08-24T14:15:22Z",      "webhook_endpoint_id": "string"    },    "job": {      "attempts": 0,      "created_at": "2019-08-24T14:15:22Z",      "emitter_id": "string",      "error_snapshot": {},      "finished_at": "2019-08-24T14:15:22Z",      "id": "string",      "job_type": "string",      "related_entity_id": "string",      "related_entity_type": "string",      "scheduled_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "status": "string",      "updated_at": "2019-08-24T14:15:22Z",      "worker_correlation_id": "string"    }  }}
POST/v1/emitters/{emitter_id}/webhooks/{endpoint_id}/test

Envía un evento sintético webhook.test, firmado como cualquier entrega, para verificar conectividad y firma. Su data es fija y nunca representa un cambio de estado fiscal.

Scope: tenant:write (también platform:admin).

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Path Parameters

emitter_id*Emitter Id
endpoint_id*Endpoint Id

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/emitters/string/webhooks/string/test"
{  "correlation_id": "string",  "data": {    "delivery": {      "attempt_number": 0,      "created_at": "2019-08-24T14:15:22Z",      "event_type": "string",      "final_status": "string",      "id": "string",      "payload_snapshot": {},      "request_at": "2019-08-24T14:15:22Z",      "request_body": "string",      "response_body_snapshot": "string",      "response_code": 0,      "updated_at": "2019-08-24T14:15:22Z",      "webhook_endpoint_id": "string"    },    "job": {      "attempts": 0,      "created_at": "2019-08-24T14:15:22Z",      "emitter_id": "string",      "error_snapshot": {},      "finished_at": "2019-08-24T14:15:22Z",      "id": "string",      "job_type": "string",      "related_entity_id": "string",      "related_entity_type": "string",      "scheduled_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "status": "string",      "updated_at": "2019-08-24T14:15:22Z",      "worker_correlation_id": "string"    }  }}
GET/v1/webhook-deliveries

Scope: platform:admin.

Authorization

KilaApiKey
X-API-Key<token>

Credencial privada del consumidor. Nunca la expongas en un navegador ni en una app cliente.

In: header

Query Parameters

limit?Limit
Range1 <= value <= 100
Default50
offset?Offset
Range0 <= value
Default0
emitter_id?string|null
endpoint_id?string|null
status?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/webhook-deliveries"
{  "correlation_id": "string",  "data": {    "deliveries": [      {        "attempt_number": 0,        "created_at": "2019-08-24T14:15:22Z",        "event_type": "string",        "final_status": "string",        "id": "string",        "payload_snapshot": {},        "request_at": "2019-08-24T14:15:22Z",        "request_body": "string",        "response_body_snapshot": "string",        "response_code": 0,        "updated_at": "2019-08-24T14:15:22Z",        "webhook_endpoint_id": "string"      }    ],    "pagination": {      "count": 0,      "limit": 0,      "offset": 0    }  }}