API Reference
HomeGuidesAPI ReferenceChangelog

Update a Webhook

put
https://api.sandbox.payments.stonex.com/api/v1/webhook

This endpoint allow you to update an existing webhook URL using the existing webhook id. This is useful if you want to change the URL to which the existing notifications should be sent.

Request

You will need to provide an exiting Webhook id in the request alongwith a new url.

Example Request

{
  "id": "678f866e853c889d0d449dbd",
  "url": "https://webhook.site/b3208726-ceca-4cb4-908e-23ca77774ed5"
}

Response

The response will confirm the update to the existing webhook url.

Example Response

{
    "clientId": "UATSFL CONNECT",
    "isActive": true,
    "webhookEventType": "PaymentStatusChanged",
    "url": "https://webhook.site/b3208726-ceca-4cb4-908e-23ca77774ed5",
    "id": "678f866e853c889d0d449dbd",
    "createdDate": "0001-01-01T00:00:00",
    "modifiedDate": "2025-01-21T13:10:31.8091835Z",
    "createdBy": "",
    "modifiedBy": "",
    "optimisticVersion": 2
}

You can also call the View Webhook by ID endpoint to check if the webhook url has been updated.

Body Params
string | null
date-time
date-time
string | null
string | null
int32
string | null
boolean
string
enum
string | null
Headers
string
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true
Responses
200

OK

500

Internal Server Error

Updated 23 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;odata.metadata=minimal;odata.streaming=true
application/json;odata.metadata=minimal;odata.streaming=false
application/json;odata.metadata=minimal
application/json;odata.metadata=full;odata.streaming=true
application/json;odata.metadata=full;odata.streaming=false
application/json;odata.metadata=full
application/json;odata.metadata=none;odata.streaming=true
application/json;odata.metadata=none;odata.streaming=false
application/json;odata.metadata=none
application/json;odata.streaming=true
application/json;odata.streaming=false
application/json
application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
application/json;odata.metadata=minimal;IEEE754Compatible=false
application/json;odata.metadata=minimal;IEEE754Compatible=true
application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
application/json;odata.metadata=full;IEEE754Compatible=false
application/json;odata.metadata=full;IEEE754Compatible=true
application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
application/json;odata.metadata=none;IEEE754Compatible=false
application/json;odata.metadata=none;IEEE754Compatible=true
application/json;odata.streaming=true;IEEE754Compatible=false
application/json;odata.streaming=true;IEEE754Compatible=true
application/json;odata.streaming=false;IEEE754Compatible=false
application/json;odata.streaming=false;IEEE754Compatible=true
application/json;IEEE754Compatible=false
application/json;IEEE754Compatible=true
text/plain
application/octet-stream
text/json

Updated 23 days ago