API リファレンス
SmartpayサイトへEnglish

Webhook エンドポイントを更新する

patch
https://api.smartpay.co/v1/webhook-endpoints/
エラー

すべての API エンドポイントに当てはまるエラーに加え、以下は Webhook のエンドポイントの更新時にのみ返されるエラーです。

ステータスコード エラーコード 説明
404 webhook-endpoint.notfound 条件に合う Webhook エンドポイントが見つかりませんでした。正しい webhookEndpointId と API キーを使用してください。テストモードのオブジェクトには、テストキーを使用してのみアクセスすることができ、ライブモードのオブジェクトには、ライブキーを使用してのみアクセスできます。
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the Webhook Endpoint object.

Body Params
boolean

Has the value true if the webhook endpoint is active and events are sent to the url specified. Has the value `false if the endpoint is inactive and the events won't be sent to the url specified.

string
length ≥ 1

An optional description for your webhook endpoint.

eventSubscriptions
array of objects

The list of events to subscribe to. If not specified you will be subsribed to all events.

eventSubscriptions
metadata
object

Set of up to 20 key-value pairs that you can attach to the object.

string
length ≥ 1

The url which will be called when any of the events you subscribed to occur.

Responses

Updated almost 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago