API referenceWebhooks

Retrieve a webhook configuration

Retrieves the webhook configuration with the given webhookConfigId.

GET/webhookConfigs/{webhookConfigId}

https://sandbox.api.mothership.com/beta

curl --request GET \
  --url 'https://sandbox.api.mothership.com/beta/webhookConfigs/48asjgaoi33nkl4t3lae' \
  --header "Authorization: Bearer $MOTHERSHIP_API_TOKEN" \
  --header 'Accept: application/json'

Reads your token from $MOTHERSHIP_API_TOKEN

Response

{

: {

: "48asjgaoi33nkl4t3lae",

: "2019-03-20T16:17:13.424Z",

: "active",

: [

"shipment.purchased",

"billOfLading.created",

"proofOfDelivery.created"

: "https://www.yourserver.io/webhook/mothership",

: "de3ADDAek3245DLAdANe91Dn3asklAMSsna03aGKkl23agsJea"

}

Hover a key to see what it means. Click it to jump to the field.

Authorization

Authorization: Bearer <token>

Your sandbox API token. See Authentication.

Path parameters

webhookConfigIdstringRequired
ID of the webhook config to fetch

Responses

- dataobject
  idstringRequired
  ID of the webhook configuration.
  createdAtstring<date-time>Required
  When this webhook configuration was created, as an ISO 8601 date-time.
  statusstringRequired
  Current status of the webhook config
  activeinactive
  subscribedEventsarray of stringsRequired
  Events that trigger a webhook.
  billOfLading.createdbillOfLading.updatedproofOfDelivery.createdproofOfDelivery.updateddeliveryReceipt.createddeliveryReceipt.updatedcertificateOfInsurance.createdshipment.purchasedWhat each value means →
  webhookUrlstringRequired
  URL that Mothership POSTs webhook events to.
  secretKeystringRequired
  Secret key for this webhook configuration, used to validate incoming webhook payloads.

What's next

Validating webhook payloads

Check every request’s signature with secretKey.