Get Webhooks

GET 
https://api.goodsdelivery.io/v1/brands/:brandId/webhooks

Authorization: x-api-key

name: x-api-keytype: apiKeyscopes: brandin: header

Use this endpoint to list all created webhooks for your brand.

Request

Path Parameters

brandId stringrequired

The ID of the brand.

Responses

200

If the request if valid, the a success response will contain a full list of all webhooks associated with the requested brand.

application/json

Schema

Schema

success booleanrequired
objects object[]required
Array [
id stringrequired
Webhook ID
url urlrequired
Where should we send notifications to.
brandId stringrequired
ID of the related brand. If provided, only notifications related to this brand will be send out. For non-internal uses, the responses will be limited by brandId associated with authenticated account.
scopes string[]required
Possible values: [DELIVERY_STATUS_UPDATED, RETURN_STATUS_UPDATED, DELIVERY_CREATED, RETURN_CREATED, ETA_AND_COORDINATES]
What types of events do we want to subscribe to.
additionalHeaders object[]
Array [
key stringrequired
value stringrequired
]
]

Example (from schema)

{
  "success": true,
  "objects": [
    {
      "id": "string",
      "url": "string",
      "brandId": "string",
      "scopes": [
        "DELIVERY_STATUS_UPDATED"
      ],
      "additionalHeaders": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.goodsdelivery.io/v1/brands/:brandId/webhooks' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.goodsdelivery.io/v1

Auth

Security Scheme

APIKeyHeaderAuthorizationHeader

APIKeyHeader

Parameters

brandId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!