SwiftPOD

Subscribe to Webhook

POST

/v1/webhooks/subscribe

Request

Header Params

string

required

Example:

application/json

Body Params application/json

Value

url

string

required

The address will be requested when you successfully register the events

event

enum<string>

required

Events can be one of the following values

Allowed values:

order_notifystock_notifyshipment_notify

name

string

required

Friendly name makes it easy to manage

Example

{
  "url": "https://eoppa0n672s2noz.m.pipedream.net",
  "event": "order_notify",
  "name": "My Webhook"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.swiftpod.com/v1/webhooks/subscribe' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://eoppa0n672s2noz.m.pipedream.net",
    "event": "order_notify", 
    "name": "My Webhook"
}'

Responses

🟢200Webhook subcribe

application/json

Body

status

boolean

required

message

string

required

Example

{
  "status": true,
  "message": "Updated webhook url successfully!"
}

Modified at 2024-08-05 04:24:17

List Webhooks

Unsubcribe to webhook