Skip to content

Getting Started

Go from zero to processing your first webhook message in less than 60 seconds.

1. Create a Webhook

  1. Log in to your Hooque Dashboard.
  2. Click New Webhook.
  3. Give it a name (e.g., "Stripe Payments").
  4. Copy your Webhook URL (e.g., https://app.hooque.io/hooks/hk_123xyz).
  5. Create a Queue and copy your Queue ID (e.g. cons_abc123) and Token.

2. Send a Test Event

You can send a test event in two ways:

  1. Via Dashboard: Go to your webhook's Test tab and click Send Payload.
  2. Via CLI: Use curl to simulate a webhook event sent by a third-party service.
curl -X POST https://app.hooque.io/hooks/hk_123xyz \
  -H "Content-Type: application/json" \
  -d '{"event": "payment.success", "amount": 2000}'

You should receive a 202 Accepted response. The message is now safely queued.

3. Consume the Message

Now, let's retrieve that message using your Queue ID and Token.

# Replace <QUEUE_ID> and <TOKEN>
curl "https://app.hooque.io/queues/<QUEUE_ID>/next" \
  -H "Authorization: Bearer <TOKEN>"

You will receive the JSON payload you sent earlier.

4. Acknowledge Processing

To complete the cycle, you must acknowledge (ack) the message so it is removed from the queue. Look for the X-Hooque-Meta header in the response from step 3 to find the deliveryId.

curl -X POST "https://app.hooque.io/queues/<QUEUE_ID>/ack/<DELIVERY_ID>" \
  -H "Authorization: Bearer <TOKEN>"

That's it! You have successfully ingested, queued, consumed, and processed a webhook event.