Webhook

Set Webhook Endpoint

This API allows you to set a webhook URL where status notifications from Yativo will be sent.

Endpoint: {{baseUrl}}/api/v1/business/webhook
Method: POST
Content-Type: application/json

{
  "url": "Your_Webhook_Address"
}

Get Webhook Endpoint

This API allows you to Get the webhook URL you set.

Endpoint: {{baseUrl}}/api/v1/business/webhook
Method: GET
Content-Type: application/json

Update Webhook Endpoint

This API allows you to Get the webhook URL you set.

Endpoint: {{baseUrl}}/api/v1/business/webhook
Method: PUT
Content-Type: application/json

PreviousEnvironments NextVerification

Last updated 2 months ago

Add/Update Webhook

post

Authorizations

Body

all ofOptional

and

anyOptionalExample: {"url":"https://webhook-test.com/c3bafd7ef3d5c13ee525832fe47d0ad4x"}

Responses

200

application/json

Responseall of

and

anyOptionalExample:

{"status":"success","status_code":200,"message":"Request successful","data":{"id":"d50e8c5b-6fda-4b53-aa4a-d719421493d6","url":"https://webhook.yativo.com/deposit/process","secret":null,"events":"general","created_at":"2024-07-31T18:46:14.000000Z","updated_at":"2024-07-31T18:46:14.000000Z"}}

post

POST /api/v1/business/webhook HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "url": "https://webhook-test.com/c3bafd7ef3d5c13ee525832fe47d0ad4x"
}

200

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "id": "d50e8c5b-6fda-4b53-aa4a-d719421493d6",
    "url": "https://webhook.yativo.com/deposit/process",
    "secret": null,
    "events": "general",
    "created_at": "2024-07-31T18:46:14.000000Z",
    "updated_at": "2024-07-31T18:46:14.000000Z"
  }
}