> For the complete documentation index, see [llms.txt](https://gitbook-v2-go126epqd-gitbook.vercel.app/url/gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook-v2-go126epqd-gitbook.vercel.app/url/gitbook.com/docs/developers/integrations/guides/receiving-requests.md).

# Handle an HTTP request

Return a JSON response from your integration's public HTTP endpoint

This guide creates an endpoint that accepts `POST` requests. It returns a JSON confirmation.

Use this pattern for webhook receivers and callback endpoints. Add your event logic after the request succeeds.

### Before you begin

Before you start, make sure that:

* You have an integration project.
* You can configure an external service or HTTP client.

### Add a request handler

In your integration entry point, add a `fetch` handler:

```typescript
export default createIntegration({
  fetch: async (request, context) => {
    if (request.method !== "POST") {
      return new Response("Method not allowed", { status: 405 });
    }

    console.log("Received a request");

    return new Response(JSON.stringify({ received: true }), {
      headers: {
        "Content-Type": "application/json",
      },
    });
  },
});
```

The handler accepts only `POST` requests. It returns `405` for other methods.

### Deploy the integration

Deploy the version that contains the handler. GitBook gives each installation a public HTTPS endpoint.

The runtime exposes this endpoint at `context.environment.integration.urls.publicEndpoint`.

### Send a test request

In your external service or HTTP client, send a `POST` request to the public endpoint.

The endpoint returns this response:

```json
{
  "received": true
}
```

If the sender uses another HTTP method, it receives `405 Method not allowed`.

### Add your integration logic

Replace the `console.log` call with your webhook or callback logic. Keep the response fast.

For the HTTP envelope, raw request body, and response details, see [HTTP communication](/url/gitbook.com/docs/developers/integrations/development/runtime.md#http-communication).

{% hint style="info" %}
Use the raw request body when your provider signs webhook payloads. Verify the signature before processing the event.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook-v2-go126epqd-gitbook.vercel.app/url/gitbook.com/docs/developers/integrations/guides/receiving-requests.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.