COconekta
Webhooks

Create Webhook

What we do at Conekta translates into events. For example, an event of interest to us occurs at the time a payment is successfully processed. At that moment we will be interested in doing several things: Send an email to the buyer, generate an invoice, start the process of shipping the product, etc.

post/webhooks

Request

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Request body

urlstring url required

Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security.

subscribed_eventsstring[]

events that will be sent to the webhook

Example request

{
  "url": "https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8"
}

Response

successful operation

idstring

id of the webhook

descriptionstring

A name or brief explanation of what this webhook is used for

livemodeboolean

Indicates if the webhook is in production

activeboolean

Indicates if the webhook is actived or not

objectstring

Object name, value is 'webhook'

statusstring

Indicates if the webhook is ready to receive events or failing

subscribed_eventsstring[]

lists the events that will be sent to the webhook

urlstring

url or endpoint of the webhook

Example response

{
  "id": "6307a60c41de27127515a575",
  "description": "Server payments processor",
  "livemode": true,
  "active": true,
  "object": "event",
  "status": "listening",
  "subscribed_events": [
    "charge.created",
    "charge.paid",
    "charge.under_fraud_review",
    "charge.fraudulent",
    "charge.refunded",
    "charge.preauthorized",
    "charge.declined",
    "charge.canceled",
    "charge.reversed",
    "charge.pending_confirmation"
  ],
  "url": "https://username:password@mockoon.conekta.io/payments-api/cash/merchant_approval"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.