> This page is for Internet banking (beta).

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://en.docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://en.docs.api.corpx.com/_mcp/server.

# Create webhook subscription

POST https://client.api.corpx.com/v1/webhooks
Content-Type: application/json

Creates a new webhook subscription for the current tenant.
Specify the URL to receive events and optionally filter by event types.


Reference: https://en.docs.api.corpx.com/ib/referencia/webhooks/create-webhook

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `Idempotency-Key` (string, optional) — Optional client-generated idempotency token (recommended for safe retries).
- `X-Request-Timestamp` (string, required) — Unix seconds. Required on the signed host; tolerance is 300s either way (`403 request_timestamp_skew`).
- `X-Content-SHA256` (string, required) — Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns `400 body_hash_mismatch`.
- `X-Request-Signature` (string, required) — Detached JWS (`<protected>..<signature>`, ES256 or PS256) over `METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256`.

### Body (application/json)

This endpoint expects an object.

- `url` (string, required) — URL to receive webhook events.
- `eventTypes` (list of string, optional) — Event types to subscribe to. If empty, subscribes to all events.
- `authType` (enum, optional, default: NONE) — Authentication applied to webhook delivery. `HMAC` signs each request with `secret` in the `X-Signature` header; `NONE` uses the platform default signature. Any other value is rejected.
  - Allowed values: `HMAC`, `NONE`
- `secret` (string, optional) — Secret used for HMAC signing. Required when `authType` is `HMAC`.
- `accountId` (string, optional) — Binds the subscription to a single account: it then receives only that account's events. Omit for a tenant-wide subscription (every account, the historical behaviour). Not editable afterwards. A credential restricted to specific accounts MUST provide it (`422 account_id_required`) and may only point at accounts it reaches (`403 forbidden`).

## Response

### 201

Webhook subscription created.

- `subscriptionId` (string, required) — Unique subscription identifier.
- `tenantId` (string, required) — Tenant that owns this subscription.
- `url` (string, required) — URL that receives webhook events.
- `active` (boolean, required) — Whether the subscription is active.
- `eventTypes` (list of string, optional) — Event types this subscription receives.
- `authType` (enum, optional) — Authentication applied to delivery.
  - Allowed values: `HMAC`, `NONE`
- `hmacSecretSet` (boolean, optional) — Whether an HMAC key is stored. The key itself is never returned by any endpoint.
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `accountId` (string, optional, nullable) — Account this subscription is bound to. `null` means tenant-wide: it receives every account's events.

## Errors

### 400 Bad Request Error

Invalid request sent by client.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 500 Internal Server Error

Unexpected server error.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

## Examples

**Request**

```json
{
  "url": "https://myapp.com/webhooks",
  "eventTypes": [
    "pix.in.completed",
    "qrcode.paid"
  ],
  "authType": "NONE",
  "secret": "whsec_9f8e7d6c5b4a3f2e1d0c",
  "accountId": "acc-123"
}
```

**Response**

```json
{
  "subscriptionId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "tenantId": "tn_7f3a9c",
  "url": "https://example.com/webhooks/corpx",
  "active": true,
  "eventTypes": [
    "pix.in.completed"
  ],
  "authType": "HMAC",
  "hmacSecretSet": true,
  "createdAt": "2026-02-20T08:33:39Z",
  "updatedAt": "2026-02-20T08:33:39Z",
  "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6"
}
```

**SDK Code**

```python Webhooks_createWebhook_example
import requests

url = "https://client.api.corpx.com/v1/webhooks"

payload = {
    "url": "https://myapp.com/webhooks",
    "eventTypes": ["pix.in.completed", "qrcode.paid"],
    "authType": "NONE",
    "secret": "whsec_9f8e7d6c5b4a3f2e1d0c",
    "accountId": "acc-123"
}
headers = {
    "X-Content-SHA256": "X-Content-SHA256",
    "X-Request-Signature": "X-Request-Signature",
    "X-Request-Timestamp": "X-Request-Timestamp",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Webhooks_createWebhook_example
const url = 'https://client.api.corpx.com/v1/webhooks';
const options = {
  method: 'POST',
  headers: {
    'X-Content-SHA256': 'X-Content-SHA256',
    'X-Request-Signature': 'X-Request-Signature',
    'X-Request-Timestamp': 'X-Request-Timestamp',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"url":"https://myapp.com/webhooks","eventTypes":["pix.in.completed","qrcode.paid"],"authType":"NONE","secret":"whsec_9f8e7d6c5b4a3f2e1d0c","accountId":"acc-123"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Webhooks_createWebhook_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://client.api.corpx.com/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://myapp.com/webhooks\",\n  \"eventTypes\": [\n    \"pix.in.completed\",\n    \"qrcode.paid\"\n  ],\n  \"authType\": \"NONE\",\n  \"secret\": \"whsec_9f8e7d6c5b4a3f2e1d0c\",\n  \"accountId\": \"acc-123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Content-SHA256", "X-Content-SHA256")
	req.Header.Add("X-Request-Signature", "X-Request-Signature")
	req.Header.Add("X-Request-Timestamp", "X-Request-Timestamp")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")
	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 Webhooks_createWebhook_example
require 'uri'
require 'net/http'

url = URI("https://client.api.corpx.com/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Content-SHA256"] = 'X-Content-SHA256'
request["X-Request-Signature"] = 'X-Request-Signature'
request["X-Request-Timestamp"] = 'X-Request-Timestamp'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://myapp.com/webhooks\",\n  \"eventTypes\": [\n    \"pix.in.completed\",\n    \"qrcode.paid\"\n  ],\n  \"authType\": \"NONE\",\n  \"secret\": \"whsec_9f8e7d6c5b4a3f2e1d0c\",\n  \"accountId\": \"acc-123\"\n}"

response = http.request(request)
puts response.read_body
```

```java Webhooks_createWebhook_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://client.api.corpx.com/v1/webhooks")
  .header("X-Content-SHA256", "X-Content-SHA256")
  .header("X-Request-Signature", "X-Request-Signature")
  .header("X-Request-Timestamp", "X-Request-Timestamp")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://myapp.com/webhooks\",\n  \"eventTypes\": [\n    \"pix.in.completed\",\n    \"qrcode.paid\"\n  ],\n  \"authType\": \"NONE\",\n  \"secret\": \"whsec_9f8e7d6c5b4a3f2e1d0c\",\n  \"accountId\": \"acc-123\"\n}")
  .asString();
```

```php Webhooks_createWebhook_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://client.api.corpx.com/v1/webhooks', [
  'body' => '{
  "url": "https://myapp.com/webhooks",
  "eventTypes": [
    "pix.in.completed",
    "qrcode.paid"
  ],
  "authType": "NONE",
  "secret": "whsec_9f8e7d6c5b4a3f2e1d0c",
  "accountId": "acc-123"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Content-SHA256' => 'X-Content-SHA256',
    'X-Request-Signature' => 'X-Request-Signature',
    'X-Request-Timestamp' => 'X-Request-Timestamp',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Webhooks_createWebhook_example
using RestSharp;

var client = new RestClient("https://client.api.corpx.com/v1/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Content-SHA256", "X-Content-SHA256");
request.AddHeader("X-Request-Signature", "X-Request-Signature");
request.AddHeader("X-Request-Timestamp", "X-Request-Timestamp");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://myapp.com/webhooks\",\n  \"eventTypes\": [\n    \"pix.in.completed\",\n    \"qrcode.paid\"\n  ],\n  \"authType\": \"NONE\",\n  \"secret\": \"whsec_9f8e7d6c5b4a3f2e1d0c\",\n  \"accountId\": \"acc-123\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Webhooks_createWebhook_example
import Foundation

let headers = [
  "X-Content-SHA256": "X-Content-SHA256",
  "X-Request-Signature": "X-Request-Signature",
  "X-Request-Timestamp": "X-Request-Timestamp",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "url": "https://myapp.com/webhooks",
  "eventTypes": ["pix.in.completed", "qrcode.paid"],
  "authType": "NONE",
  "secret": "whsec_9f8e7d6c5b4a3f2e1d0c",
  "accountId": "acc-123"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://client.api.corpx.com/v1/webhooks")! 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()
```