Our API is currently in open beta, if you encounter any issues or have a suggestion, please email us at [email protected]. Your insights are invaluable to us.

Lumaprints API

Subscribe to a new event

Sandbox

POST

https://us.api-sandbox.lumaprints.com/api/v1/webhook

When setting up a new webhook subscription, our system will verify the provided URL, along with the optional username and password. If the verification fails, the subscription will be rejected. For the verification to succeed, your endpoint must respond with a status code of 200.

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 *****************

Body Params application/json

event

enum<string>

required

The event that will trigger the webhook.

Allowed value:

shipping

Example:

shipping

storeId

number

required

The ID of the store.

Example:

1088

url

string

required

The URL to send the webhook to.

Example:

https://www.example.com/webhook

username

string | null

optional

If the url is using a basic auth, the username of the basic auth.

Example:

Lumaprints

password

string | null

optional

If the url is using a basic auth, the password of the basic auth.

Example:

Password123

Example

{
  "event": "shipping",
  "storeId": "1088",
  "url": "https://www.example.com/webhook",
  "username": "Lumaprints",
  "password": "Password123"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://us.api-sandbox.lumaprints.com/api/v1/webhook' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "shipping",
    "storeId": "1088",
    "url": "https://www.example.com/webhook",
    "username": "Lumaprints",
    "password": "Password123"
}'

Responses

🟢201Created

application/json

Body

status

integer

required

message

string

required

Examples

SuccessSuccessSuccess

{
  "status": 201,
  "message": "Webhook has been successfully created."
}

🟠400Duplicate Webhook URL

🟠400URL Not accessible

Modified at 2024-08-29 23:29:17

Shipping cost