Sign in
Webhooks

Create webhook

Creates a new webhook for receiving events

post/env/webhooks

Request

  • Base URL: https://api.inngest.com/v2
  • URL: https://api.inngest.com/v2/env/webhooks
  • Auth: API key in header Authorization

Headers

X-Inngest-Envstring required

Target environment for the webhook (e.g., 'production', 'staging', 'development')

Request body

namestring

Descriptive name for the webhook

responsestring

Optional inline JS function which is called to respond to GET requests

transformstring

The inline JS transform function for incoming events

Example request

{
  "eventFilter": {
    "events": [
      "orders/payment.created",
      "orders/*"
    ]
  },
  "name": "Payment Processing Webhook",
  "response": "function respond(body, headers) { return { status: 200, headers: {}, body: JSON.parse(body)?.challenge } };",
  "transform": "function transform(evt, headers = {}, queryParams = {}, raw = '') { return { name: 'webhook/request.received', data: evt }; }"
}

Response

Webhook successfully created

Example response

{
  "data": {
    "eventFilter": {
      "events": [
        "orders/payment.created",
        "orders/*"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.