Create Webhook

Create a new webhook subscription.

POST /webhooks

Create Webhook

cURL

curl --request POST \
  --url https://api.loopreturns.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "status": "inactive"
}
'

200

{
  "id": 123,
  "shop_id": 123,
  "url": "<string>"
}

Authorizations

oauth2api_key

Authorization · string · header · required

OAuth 2.0 authorization

Body

application/json

topic · enum<string> · required

The webhook's topic.

Available options: return, label, restock, label.request, giftcard, happy.returns.shipment

Example:

"return"

trigger · enum<string> · required

The condition which triggers the webhook.

Available options: return.created, return.updated, return.closed, label.created, label.updated, restock.requested, label.request.issued, label.request.cancelled, giftcard.requested, shipment.processed

Example:

"return.created"

url · string · required

The webhook's URL.

Example:

"https://example.com/webhook"

status · enum<string> · default: inactive

The webhook's status.

Available options: active, inactive

Response

200

application/json

Success

id · integer

The webhook's unique identifier.

Example:

12345

shop_id · integer

The unique identifier of the shop that created the webhook.

Example:

65432

topic · enum<string>

The webhook's topic.

Available options: return, label, restock, label.request, giftcard, happy.returns.shipment

Example:

"return"

trigger · enum<string>

The condition which triggers the webhook.

Available options: return.created, return.updated, return.closed, label.created, label.updated, restock.requested, label.request.issued, label.request.cancelled, giftcard.requested, shipment.processed

Example:

"return.created"

url · string

The webhook's URL.

Example:

"https://example.com/webhook"

status · enum<string>

The webhook's status.

Available options: active, inactive