Skip to content
WebsitePlatform

Webhook URL

What a webhook URL accepts, and how Hookspot answers the sender.

A webhook URL is the address you give a service to receive its webhooks in Hookspot. Send a request below, then check what each response means.

Copy the curl command from the source’s Overview and run it in any directory. Replace its body to test your own event:

curl <webhook-url> -H 'content-type: application/json' --data-raw '{"type":"order.created"}'
{"status":"ok","request_id":"req_OkxrPJJvJq91H3RdE3rYJFpRAQ"}

request_id is the ID the request has under Requests. The 200 means Hookspot stored the request, not that your app got it. The request can still be Rejected.

  • Any HTTP method.
  • Any query string. Your app gets it with the request.
  • Any body up to 3 MiB, stored byte for byte.
  • Requests from any sender, unless the source verifies its senders.
Status When
200 The source exists, and Hookspot stored the request. The body is the JSON above, or your custom reply.
200 A Slack source got Slack’s URL check. The body is the challenge, and Hookspot stores nothing.
401 The source verifies its senders, and the request’s signature or credentials are missing or wrong. Hookspot stores it as Rejected with Verification failed and answers {"status":"error","error":"verification_failed"}.
405 No source has this URL, for example because it was deleted. Hookspot stores nothing and answers {"status":"error"}.
413 The body is over 3 MiB. Hookspot stores nothing.
429 The organization reached its hard limit for the month. Hookspot stores nothing and answers {"status":"error","error":"monthly_delivery_limit_reached"}.
429 The organization went over its daily data limit. Hookspot stores nothing and answers {"status":"error","error":"rate_limited"}.
503 Hookspot cannot take the request right now, and it normally stores nothing. It answers {"status":"error","error":"service_unavailable"} with the header Retry-After: 60, so send the request again after those 60 seconds. If Hookspot timed out while storing the request, sending it again can store a second request.

A paused source, or a source without a route, still answers 200 to a request that passes verification. Hookspot stores the request and marks it Rejected.