Update a Webhook - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

id

string

required

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

description

string

optional

An optional description of what the webhook is used for.

enabled_events

array[string]

optional

The list of events to enable for this endpoint.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

url

string

optional

The URL of the webhook endpoint.

disabled

boolean

optional

Disable the webhook endpoint if set to true.

Example

{
  "url": "https://another_address.com"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apitest.wooshpay.com/v1/webhook_endpoints/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "url": "https://another_address.com"
}'

Responses

🟢200OK

application/json

Body

id

string

optional

Unique identifier for the object, like "we_xxxxx"

object

string

optional

"webhook_endpoint"

Default:

"webhook_endpoint"

api_version

string

optional

The API version events are rendered as for this webhook endpoint.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

description

string

optional

An optional description of what the webhook is used for.

enabled_events

array[string]

optional

The list of events to enable for this endpoint.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

status

string

optional

The status of the webhook. It can be enabled or disabled.

secret

string

optional

The endpoint’s secret, used to generate webhook signatures. Only returned at creation.

url

string

optional

The URL of the webhook endpoint.

Example

{
  "id": "we_1M3fqHHTdYyGj2Y6LeGVaamQ",
  "object": "webhook_endpoint",
  "api_version": null,
  "created": 1668344601,
  "description": "This is my webhook, I like it a lot",
  "enabled_events": [
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
    "charge.refund.updated",
    "charge.dispute.updated"
  ],
  "livemode": false,
  "metadata": {},
  "status": "enabled",
  "url": "https://example.com/my/webhook/endpoint",
  "secret": "whsec_9rMfZUGWM3gTTBtn0f8kPEfmiIJCmzQi"
}