GuidesRecipesAPI Reference
API Reference

Create webhook configuration

post
https://api.moderndropship.com/webhooks

The endpoint allows you to create a new webhook configuration to subscribe to topics and have events sent to a target URL.

Newly created webhooks are by default deactived (active=false) to prevent events being sent to webhooks that aren't ready. After creating a new webhook make sure to update it and set active=true

Body Params

A new webhook configuration

integer
≥ 1
Defaults to 0

The highest burst rate of requests used by the limiter to determine delivery speed of new topics to the target URL. Must be smaller than or equal to the limiterRate defined above. Must be a positive integer. Default value is 0 which means NO LIMIT

integer
≥ 1
Defaults to 0

The limiter rate used to thorttle topic delivery to the target URL. Must be a positive integer. Default value is 0 which means NO LIMIT

secrets
array of objects
required

A list of secrets used to create Convictional-Signature headers to verify webhook data integrety. You are able to attach more than one secret to a webhook configuration and both validation tokens will be sent. This is to assit with token renewals so that your webhook can migrate from one token to the other without any downtime.

secrets*
string
required

The full URL to which new webhook events are POSTed

topics
array of strings
required
length ≥ 1

List of topics that the URL specified by this configuration should receive

topics*
Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago