getstarted.ae

Create a webhook endpoint

POSThttps://api.getstarted.ae/v1/webhooks

Registers an HTTPS URL to receive events. The signing secret is returned once, in this response only.

  • Store secret straight away. If you lose it, delete the endpoint and create a new one. See Verifying signatures.

Body parameters

  • urlstringrequired

    HTTPS URL that accepts POST requests.

  • eventsarrayrequired

    Event types to send. Use ["*"] for all.

  • descriptionstring

    A note for your team.

Responses

  • 201Created. Returns the object shown in the example.
  • 400unknown_field The body contains a key the endpoint does not accept.
  • 422invalid_url The URL is not HTTPS or does not resolve.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X POST "https://api.getstarted.ae/v1/webhooks" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://api.northwindlabs.com/hooks/getstarted",
  "events": [
    "incorporation.status_changed",
    "incorporation.issue_created",
    "incorporation.issue_resolved",
    "incorporation.completed"
  ],
  "description": "Production incorporation events"
}'
Response · 201
{
  "id": "whk_01J9ZKJ3GX7N2S",
  "object": "webhook",
  "url": "https://api.northwindlabs.com/hooks/getstarted",
  "events": [
    "incorporation.status_changed",
    "incorporation.issue_created",
    "incorporation.issue_resolved",
    "incorporation.completed"
  ],
  "status": "ENABLED",
  "description": "Production incorporation events",
  "livemode": false,
  "createdAt": "2026-09-20T09:10:05Z",
  "secret": "whsec_7Xk2pQ9rT4vW8yZ1bN5mC3dF6gH0jL"
}