Create Webhook Subscription

Create a new webhook subscription. If called with a marketplace API key, the subscription will be at the marketplace level. If called with merchant credentials or if the Merchant-Id header is provided, the subscription will be at the merchant level.

SecurityMarketplace API Key | Merchant Secret Token | Marketplace JWT | Merchant JWT

Request

header Parameters

Merchant-Id

string

Perform operation in the context of the given merchant. Usually not required — specify only if acting on behalf of a merchant not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
required

One of:

required

object (CreateWebhookMarketplaceSubscription1)

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/webhooks

Request samples

Payload
Curl
JavaScript

application/json

{"CreateWebhookMarketplaceSubscription": {"url": "https://api.myservice.io/events",
"events": ["MerchantCreated"
],
"description": "string",
"metadata": { }
}
}

Response samples

application/json

{"WebhookMarketplaceSubscription": {"id": "webhook_Z2OS1pJDfRbNb_S8",
"marketplaceId": "mktp_Z2OSz5JDfRbNb_Si",
"url": "https://api.myservice.io/events",
"events": ["MerchantCreated"
],
"description": "string",
"metadata": { },
"status": "Active",
"secret": "string"
}
}