Create webhook subscription

Authorization

authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

Webhook subscription params

is_active?|

Indicates whether the webhook subscription should be created as active

Defaulttrue

topic*string

The topic of the webhook subscription

Value in"LABEL_PURCHASED" | "LABEL_VOIDED" | "LABEL_TRACKING_UPDATED"

url*string

The URL to which webhook events will be sent

Match(?:https)://(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,255}\.[a-z]{2,9}\b([-a-zA-Z0-9@:%_+.~#?!&>//=]*)$

Response Body

`application/json`

curl -X POST "https://api.parsel.app/webhooks" \  -H "Content-Type: application/json" \  -d '{    "is_active": true,    "topic": "LABEL_TRACKING_UPDATED",    "url": "https://example.com/webhook"  }'

{
  "created_at": {},
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_active": true,
  "secret": "dG9wX3NlY3JldF9rZXlfZm9yX3BhcnNlbF93ZWJob29rc18yMDI0XzEyXzE5",
  "topic": "LABEL_TRACKING_UPDATED",
  "updated_at": {},
  "url": "https://example.com/webhook"
}

{
  "errors": {
    "message": "The request could not be processed",
    "reasons": [
      {
        "carrier": "UniUni",
        "message": "Zip code not serviced."
      }
    ],
    "status": "Unprocessable Entity"
  }
}

Create webhook subscription

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`