Crear Webhook Endpoint
Changed onRegistra un webhook endpoint para la organización autenticada.
Una URL puede tener varios endpoints mientras ninguno comparta eventos con otro. Si ya existe un endpoint en la misma URL con exactamente los mismos eventos, se actualiza en lugar de crear uno nuevo; si comparte solo algunos, responde 409. Devuelve el endpoint con su ID y su secret. El estado por defecto es enabled.
Request
- Base URLhttps://api.trytoku.com
- URLhttps://api.trytoku.com/webhook_endpoints
- AuthAPI key in header x-api-key
Request body
Response
Successful Response
Example response
{
"custom_headers_keys": [
"X-Custom-Token"
],
"enabled_events": [
"transaction.success",
"transaction.failed"
],
"id": "whe_R7kPq2mNvB4xC8dF1hJ5tW9sZ3aY",
"secret": "whesec_L6oI8uY7tR5eW3qA1sD9fG2hJ4kZ",
"url": "https://example.com/webhooks/toku",
"webhook_version": "2024-04-01"
}Changes
- breaking
request body became required
- breaking
request property
/was restricted to a list of enum values - breaking
request property
was restricted to a list of enum values - breaking
the
request property's minLength was increased from0to1 - breaking
the
request property type changed fromstringtoobject, and format fromjsonto no format - breaking
the
request property format changed from no format touri - breaking
removed the media type
application/jsonfor the response with the status - breaking
removed the media type
application/jsonfor the response with the status - breaking
the
response's property type changed fromstringto no type for status - warning
the
request property's maxLength was set to2083 - warning
added the new
activation.createdenum value to the/response property for the response status - warning
added the new
bank_account_verification.resultenum value to the/response property for the response status - warning
added the new
billing_document.createdenum value to the/response property for the response status - warning
added the new
chargeback.status_updateenum value to the/response property for the response status - warning
added the new
checkout_session.accessedenum value to the/response property for the response status - warning
added the new
checkout_session.expiredenum value to the/response property for the response status - warning
added the new
client_bank_movements.bulk_createdenum value to the/response property for the response status - warning
added the new
customer.createdenum value to the/response property for the response status - warning
added the new
customer.deletedenum value to the/response property for the response status - warning
added the new
customer.updatedenum value to the/response property for the response status - warning
added the new
debt_reconciliation.reconciledenum value to the/response property for the response status - warning
added the new
document.canceledenum value to the/response property for the response status - warning
added the new
document.failedenum value to the/response property for the response status - warning
added the new
document.signedenum value to the/response property for the response status - warning
added the new
interaction.incomingenum value to the/response property for the response status - warning
added the new
invoice.createdenum value to the/response property for the response status - warning
added the new
invoice.paidenum value to the/response property for the response status - warning
added the new
invoice.refundenum value to the/response property for the response status - warning
added the new
invoice.updatedenum value to the/response property for the response status - warning
added the new
invoice.voidedenum value to the/response property for the response status - warning
added the new
invoice_restructuring.completedenum value to the/response property for the response status - warning
added the new
operation_receipt.createdenum value to the/response property for the response status - warning
added the new
payment_instrument.createdenum value to the/response property for the response status - warning
added the new
payment_instrument.updatedenum value to the/response property for the response status - warning
added the new
payment_method.attached_productsenum value to the/response property for the response status - warning
added the new
payment_method.deletedenum value to the/response property for the response status - warning
added the new
payment_method.status_updateenum value to the/response property for the response status - warning
added the new
payment_method.updatedenum value to the/response property for the response status - warning
added the new
payment_method_inscription_intent.failedenum value to the/response property for the response status - warning
added the new
payout.doneenum value to the/response property for the response status - warning
added the new
payout_br.successenum value to the/response property for the response status - warning
added the new
payout_cl.successenum value to the/response property for the response status - warning
added the new
payout_mx.successenum value to the/response property for the response status - warning
added the new
rendition_file.createdenum value to the/response property for the response status - warning
added the new
rendition_file.successenum value to the/response property for the response status - warning
added the new
rendition_file.uploadedenum value to the/response property for the response status - warning
added the new
subscription.createdenum value to the/response property for the response status - warning
added the new
subscription.deletedenum value to the/response property for the response status - warning
added the new
subscription.updatedenum value to the/response property for the response status - warning
added the new
transaction.bulk_failedenum value to the/response property for the response status - warning
added the new
transaction.bulk_successenum value to the/response property for the response status - warning
added the new
transaction.capture_pendingenum value to the/response property for the response status - warning
added the new
transaction.failedenum value to the/response property for the response status - warning
added the new
transaction.refundenum value to the/response property for the response status - warning
added the new
transaction.renewedenum value to the/response property for the response status - warning
added the new
transaction.status_updateenum value to the/response property for the response status - warning
added the new
transaction.successenum value to the/response property for the response status - warning
added the new
transaction_external.successenum value to the/response property for the response status - warning
added the new
validator_execution.resultenum value to the/response property for the response status - info
api operation id
crear-webhook-endpointremoved and replaced withcreate_webhook_endpoint - info
api tag
Webhook Endpointsadded - info
added the new optional request property
- info
added the new
activation.createdenum value to the request property/ - info
added the new
bank_account_verification.resultenum value to the request property/ - info
added the new
billing_document.createdenum value to the request property/ - info
added the new
chargeback.status_updateenum value to the request property/ - info
added the new
checkout_session.accessedenum value to the request property/ - info
added the new
checkout_session.expiredenum value to the request property/ - info
added the new
client_bank_movements.bulk_createdenum value to the request property/ - info
added the new
customer.createdenum value to the request property/ - info
added the new
customer.deletedenum value to the request property/ - info
added the new
customer.updatedenum value to the request property/ - info
added the new
debt_reconciliation.reconciledenum value to the request property/ - info
added the new
disabledenum value to the request property - info
added the new
document.canceledenum value to the request property/ - info
added the new
document.failedenum value to the request property/ - info
added the new
document.signedenum value to the request property/ - info
added the new
enabledenum value to the request property - info
added the new
interaction.incomingenum value to the request property/ - info
added the new
invoice.createdenum value to the request property/ - info
added the new
invoice.paidenum value to the request property/ - info
added the new
invoice.refundenum value to the request property/ - info
added the new
invoice.updatedenum value to the request property/ - info
added the new
invoice.voidedenum value to the request property/ - info
added the new
invoice_restructuring.completedenum value to the request property/ - info
added the new
operation_receipt.createdenum value to the request property/ - info
added the new
payment_instrument.createdenum value to the request property/ - info
added the new
payment_instrument.updatedenum value to the request property/ - info
added the new
payment_method.attached_productsenum value to the request property/ - info
added the new
payment_method.deletedenum value to the request property/ - info
added the new
payment_method.status_updateenum value to the request property/ - info
added the new
payment_method.updatedenum value to the request property/ - info
added the new
payment_method_inscription_intent.failedenum value to the request property/ - info
added the new
payout.doneenum value to the request property/ - info
added the new
payout_br.successenum value to the request property/ - info
added the new
payout_cl.successenum value to the request property/ - info
added the new
payout_mx.successenum value to the request property/ - info
added the new
rendition_file.createdenum value to the request property/ - info
added the new
rendition_file.successenum value to the request property/ - info
added the new
rendition_file.uploadedenum value to the request property/ - info
added the new
subscription.createdenum value to the request property/ - info
added the new
subscription.deletedenum value to the request property/ - info
added the new
subscription.updatedenum value to the request property/ - info
added the new
transaction.bulk_failedenum value to the request property/ - info
added the new
transaction.bulk_successenum value to the request property/ - info
added the new
transaction.capture_pendingenum value to the request property/ - info
added the new
transaction.failedenum value to the request property/ - info
added the new
transaction.refundenum value to the request property/ - info
added the new
transaction.renewedenum value to the request property/ - info
added the new
transaction.status_updateenum value to the request property/ - info
added the new
transaction.successenum value to the request property/ - info
added the new
transaction_external.successenum value to the request property/ - info
added the new
validator_execution.resultenum value to the request property/ - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added to the
response propertyallOflist for the response status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status
- breaking