> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.tryenvoy.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tryenvoy.ai/_mcp/server. # Register a webhook endpoint POST https://tryenvoy.ai/api/v1/webhooks/endpoints Content-Type: application/json Create a webhook endpoint and receive its signing secret. The secret is returned exactly once in this response — store it immediately; it cannot be retrieved later. **Authentication:** Supports API key and bearer token authentication. Reference: https://docs.tryenvoy.ai/api-reference/endpoints/api/create-endpoint-api-v-1-webhooks-endpoints-post ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://tryenvoy.ai/api/v1` (Production, default) - `https://staging.tryenvoy.ai/api/v1` (Staging) ## Request ### Headers - `X-Organization-ID` (string, optional, nullable) - `Idempotency-Key` (string, optional) — A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with `Idempotent-Replayed: true` instead of running twice. The same key with a different request returns 422 `idempotency_key_reused`; while the first request is still running, 409 `idempotency_key_in_progress`. 5xx and 429 responses are not stored. ### Body (application/json) This endpoint expects a WebhookEndpointCreateRequest. - `url` (string, required) — HTTPS URL we will POST events to - `event_types` (list of string, required) — Allowlist of event type names (e.g. ['elp_test.scored']). Must contain at least one entry. - `description` (string, optional, nullable) - `headers` (map from string to string, optional, nullable) — Optional static headers we will include on every request to this endpoint. ## Response ### 201 Successful Response - `id` (string, required) - `organization_id` (string, required) - `url` (string, required) - `description` (string, required, nullable) - `event_types` (list of string, required) - `headers` (map from string to string, required, nullable) - `status` (enum, required) — Endpoint lifecycle state. ``DISABLED`` is reserved for automatic disable by the auto-disable job; ``PAUSED`` is explicitly paused and indicates intent to resume. - Allowed values: `ACTIVE`, `PAUSED`, `DISABLED` - `disabled_reason` (string, required, nullable) - `created_at` (datetime, required) - `updated_at` (datetime, required) - `signing_secret` (string, required) — `whsec_` — store this; it is not retrievable later. ## Errors ### 401 Unauthorized Error Not authenticated - missing or invalid token/API key - `any` ### 403 Forbidden Error Insufficient permissions for this operation - `any` ### 409 Conflict Error `idempotency_key_in_progress`: a request with this Idempotency-Key is still running; retry later - `any` ### 422 Unprocessable Entity Error Validation Error; or `idempotency_key_reused`: this Idempotency-Key was already used for a different request - `detail` (list of ValidationError, optional) ### 429 Too Many Requests Error Rate limit exceeded - see Retry-After header - `any` ## Types ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) - `input` (any, optional) - `ctx` (ValidationErrorCtx, optional) ### ValidationErrorLocItems ### ValidationErrorCtx ## Examples **Request** ```json { "url": "string", "event_types": [ "string" ] } ``` **Response** ```json { "id": "ep_00000000-0000-0000-0000-000000000000", "organization_id": "org_00000000-0000-0000-0000-000000000000", "url": "string", "description": "string", "event_types": [ "string" ], "headers": {}, "status": "ACTIVE", "disabled_reason": "string", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "signing_secret": "string" } ``` **SDK Code** ```python import requests url = "https://tryenvoy.ai/api/v1/webhooks/endpoints" payload = { "url": "string", "event_types": ["string"] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://tryenvoy.ai/api/v1/webhooks/endpoints'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"url":"string","event_types":["string"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://tryenvoy.ai/api/v1/webhooks/endpoints" payload := strings.NewReader("{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://tryenvoy.ai/api/v1/webhooks/endpoints") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://tryenvoy.ai/api/v1/webhooks/endpoints") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ]\n}") .asString(); ``` ```php request('POST', 'https://tryenvoy.ai/api/v1/webhooks/endpoints', [ 'body' => '{ "url": "string", "event_types": [ "string" ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://tryenvoy.ai/api/v1/webhooks/endpoints"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"url\": \"string\",\n \"event_types\": [\n \"string\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "url": "string", "event_types": ["string"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://tryenvoy.ai/api/v1/webhooks/endpoints")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```