POST webhooks¶

Create a webhook. The response includes the signing secret. Store it: this is the only time it's returned.

Endpoint¶

POST https://dropday.io/api/v1/webhooks

Parameters¶

Field	Type	Description
name	String	A name for the webhook, shown on the settings page. Max 255 characters.
description `optional`	String	A description. Max 1000 characters.
url	String	The URL deliveries are sent to. Max 500 characters. Must be unique within your account.
events	String[]	One or more event names from GET webhooks/events.
active `optional`	Boolean	Defaults to `true`.

If your account already has a webhook with this url, the request returns 422. Look it up with GET webhooks and update it instead.

Request¶

curl -X POST "https://dropday.io/api/v1/webhooks" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "api-key: tdh7nNUp3DZAHsMtw3dQYhDsm3wf593hMGbyXP6Y5R8DTF2Rwy4QCvkWFYQb" \
  -H "account-id: 101" \
  -d '{
    "name": "Magento",
    "description": "Installed by the Magento module",
    "url": "https://shop.example.com/dropday/webhook",
    "events": ["supplier_order.created", "supplier_order.shipped"]
}'

Response¶

201422403

{
    "data": {
        "id": 12,
        "name": "Magento",
        "description": "Installed by the Magento module",
        "url": "https://shop.example.com/dropday/webhook",
        "events": ["supplier_order.created", "supplier_order.shipped"],
        "active": true,
        "secret": "whsec_3kq8Zr1VbN7xYc2LmP4tWd9HsF6gJa0E",
        "last_delivered_at": null,
        "last_failed_at": null,
        "created_at": "2026-10-20T12:00:00.000000Z",
        "updated_at": "2026-10-20T12:00:00.000000Z"
    }
}

{
    "message": "The given data was invalid.",
    "errors": {
        "url": [
            "A webhook with this URL already exists."
        ]
    }
}

{
    "message": "Unauthorized."
}