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

# Webhook Creation

POST https://sandbox-payments.nolimit.money/interac/webhooks
Content-Type: application/json

API call to create a webhooks tied to your Interac account. The events shared via the webhook are related to the transaction status changes. New transactions will not fire a webhook.

Body parameters are required:\
`apiKey - [string]` will be used in the webhook's header data send to your webhool

`authorizationHeaderName`

`url` - your webhook URL incl. `https://...`

Response will include the `id` which can be used to delete a webhook if needed.

Sample webhook responses

```json
{
  "deposit": {
    "id": "2ffb7139-0b50-4840-998b-3cafbe80ebfa",
    "interacSenderEmail": "john.doe@example.com",
    "interacRecipientEmail": "payments@example.com",
    "postedAmount": "20.00",
    "status": "SENT",
    "referenceCode": "H3GZDLGI",
    "memo": "ACME INC. Payment for Order #HJ68GY75",
    "createdAt": "2025-11-27T14:51:28.198Z",
    "postedAt": "2025-11-27T14:51:30.454Z"
  },
  "partner_balance": "NaN"
}

```

```json
{
  "deposit": {
    "id": "c15702ab-88e6-41a1-8e29-86fbee76f077",
    "interacSenderEmail": "john.smith@example.com",
    "interacRecipientEmail": "payments@example.com",
    "postedAmount": "11.11",
    "status": "COMPLETED",
    "referenceCode": "SBBI7VQY",
    "memo": "ACME INC. Payment for Order #HJ6G5GD5",
    "createdAt": "2025-11-27T17:24:24.724Z",
    "postedAt": "2025-11-27T17:24:26.157Z"
  },
  "partner_balance": "11.11"
}

```

Reference: https://interacdocs.nolimit.money/partner-interac-api/webhook-creation

## Servers

- `https://sandbox-payments.nolimit.money/interac` (Sandbox, default)
- `https://payments.nolimit.money/interac` (Production)

## Request

### Headers

- `x-api-key` (string, optional)

### Body (application/json)

This endpoint expects an object.

- `apiKey` (string, required)
- `authorizationHeaderName` (string, required)
- `url` (string, required)

## Response

### 201

Created

- `data` (WebhooksPostResponsesContentApplicationJsonSchemaData, required)
- `success` (integer, required)

## Types

### WebhooksPostResponsesContentApplicationJsonSchemaData

- `id` (integer, required)
- `authorizationHeaderName` (string, required)
- `url` (string, required)
- `apiKey` (string, required)

## Examples

**Request**

```json
{
  "apiKey": "oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=",
  "authorizationHeaderName": "authorization",
  "url": "https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125"
}
```

**Response**

```json
{
  "data": {
    "id": 4,
    "authorizationHeaderName": "authorization",
    "url": "https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125",
    "apiKey": "oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY="
  },
  "success": 1
}
```

**SDK Code**

```python Webhook Creation_example
import requests

url = "https://sandbox-payments.nolimit.money/interac/webhooks"

payload = {
    "apiKey": "oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=",
    "authorizationHeaderName": "authorization",
    "url": "https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125"
}
headers = {
    "x-api-key": "{{kid}}@{{api-key}}",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Webhook Creation_example
const url = 'https://sandbox-payments.nolimit.money/interac/webhooks';
const options = {
  method: 'POST',
  headers: {'x-api-key': '{{kid}}@{{api-key}}', 'Content-Type': 'application/json'},
  body: '{"apiKey":"oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=","authorizationHeaderName":"authorization","url":"https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125"}'
};

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

```go Webhook Creation_example
package main

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

func main() {

	url := "https://sandbox-payments.nolimit.money/interac/webhooks"

	payload := strings.NewReader("{\n  \"apiKey\": \"oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=\",\n  \"authorizationHeaderName\": \"authorization\",\n  \"url\": \"https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125\"\n}")

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

	req.Header.Add("x-api-key", "{{kid}}@{{api-key}}")
	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 Webhook Creation_example
require 'uri'
require 'net/http'

url = URI("https://sandbox-payments.nolimit.money/interac/webhooks")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '{{kid}}@{{api-key}}'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"apiKey\": \"oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=\",\n  \"authorizationHeaderName\": \"authorization\",\n  \"url\": \"https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125\"\n}"

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

```java Webhook Creation_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://sandbox-payments.nolimit.money/interac/webhooks")
  .header("x-api-key", "{{kid}}@{{api-key}}")
  .header("Content-Type", "application/json")
  .body("{\n  \"apiKey\": \"oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=\",\n  \"authorizationHeaderName\": \"authorization\",\n  \"url\": \"https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://sandbox-payments.nolimit.money/interac/webhooks', [
  'body' => '{
  "apiKey": "oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=",
  "authorizationHeaderName": "authorization",
  "url": "https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '{{kid}}@{{api-key}}',
  ],
]);

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

```csharp Webhook Creation_example
using RestSharp;

var client = new RestClient("https://sandbox-payments.nolimit.money/interac/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "{{kid}}@{{api-key}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"apiKey\": \"oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=\",\n  \"authorizationHeaderName\": \"authorization\",\n  \"url\": \"https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Webhook Creation_example
import Foundation

let headers = [
  "x-api-key": "{{kid}}@{{api-key}}",
  "Content-Type": "application/json"
]
let parameters = [
  "apiKey": "oe1Rv8hOeq8dJZUwoqlnmtFacBTE1zav5rAzx2V95JY=",
  "authorizationHeaderName": "authorization",
  "url": "https://webhook.site/b23037bf-583f-4093-b422-0587ceb6c125"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-payments.nolimit.money/interac/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()
```