Update Webhook API

• Introduction
• Request and Response

Introduction

This API provides an interface to update a webhook at customer account.

Request and Response

This API only accepts PUT requests.

Development API End Point URL

https://dev-api.aymakan.com.sa/v2/webhooks/update

Production API End Point URL

https://api.aymakan.net/v2/webhooks/update

Headers

The following headers should be sent along with the request

• Accept: application/json
• Authorization: Your account security code / Api Token

Request

Below is the list of parameters which should be sent to this API to create a webhook.

{info} The request parameters should be sent in request body using JSON format.

A sample PUT request body is below:

{
    "id": 195 ,
    "webhook_url": "https://test-webhook-url.com"
}

Response

Success Response

The following response will be returned upon success.

{
    "success": true,
    "data": {
        "webhook": {
            "id": 195,
            "webhook_url": "https://test-webhook-url.com",
            "call_method": "POST",
            "active": 1,
            "created_at": "2021-02-07T10:05:08.000000Z",
            "updated_at": "2021-09-02T09:01:08.000000Z"
        }
    }
}

Error Response

In case the account does not have any webhook setup, the following error will be returned.

{
    "error": true,
    "message": "WebHook not found."
}

Also, an HTTP status of 422 Unprocessable Entity will be returned.

In case of invalid credentials 401 Unauthorized, the following response will be returned.

{
    "error": true,
    "response": "Invalid Credentials"
}