> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get subscribed webhooks

> Retrieves a paginated list of all active webhook subscriptions configured for the authenticated partner account.

### Headers

**x-api-version** `string` *required*

Target API version (e.g. `1.2`).

### Query Parameters

**page** `number`

Page number to retrieve for pagination (defaults to `1`).

**limit** `number`

Number of webhook records per page (defaults to `10`).

### Response Body

**pagination** `object`

Pagination information including `currentPage`, `pageSize`, `totalCount`, and `totalPages`.

**webhooks** `array of objects`

List of active webhook subscriptions configured for this partner.

**webhooks\[].id** `number`

Unique identifier of the webhook subscription.

**webhooks\[].url** `string`

Registered destination HTTPS endpoint URL.

**webhooks\[].secretKey** `string`

Secret key used to verify HMAC signatures of delivered payloads.

**webhooks\[].eventIds** `array of numbers`

Array of event IDs subscribed to this endpoint.

**webhooks\[].events** `object`

Full metadata for all subscribed event definitions grouped by domain category (e.g. `payout`).

**webhooks\[].createdAt** `string`

ISO 8601 timestamp when the webhook was registered.

**webhooks\[].updatedAt** `string`

ISO 8601 timestamp of last modification.

### Response Codes

| Code | Description |
| - | - |
| 200 | Subscribed webhooks retrieved successfully. |
| 401 | Unauthorized. Missing, expired, or invalid partner Bearer token. |
| 500 | Internal Server Error. |

```bash cURL theme={null}
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks \
  -H "Content-Type: application/json" \
  -H "X-API-Version: 1.2" \
  -H "Authorization: Bearer <accessToken>"
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks", {
  method: "GET",
  headers: {
    Authorization: "Bearer <accessToken>",
    "Content-Type": "application/json",
    "X-API-Version": "1.2",
  },
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.get(
    "https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks",
    headers={
        "Authorization": "Bearer <accessToken>",
        "Content-Type": "application/json",
        "X-API-Version": "1.2",
    },
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["Content-Type"] = "application/json"
request["X-API-Version"] = "1.2"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <accessToken>",
        "Content-Type: application/json",
        "X-API-Version: 1.2",
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks"))
            .header("Authorization", "Bearer <accessToken>")
            .header("Content-Type", "application/json")
            .header("X-API-Version", "1.2")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

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

func main() {
	req, err := http.NewRequest("GET", "https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <accessToken>")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Version", "1.2")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-payments.mygigsters.com.au/api/v1/partner/webhooks");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<accessToken>");
request.Headers.Add("X-API-Version", "1.2");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json Response theme={null}
{
  "pagination": {
    "current_page": 1,
    "page_size": 10,
    "total_count": 2,
    "total_pages": 1
  },
  "webhooks": [
    {
      "id": 2,
      "url": "https://example.com/webhook",
      "secret_key": "LptaMacK*9o$HZEAkY0H",
      "event_ids": [
        13,
        14,
        15
      ],
      "events": {
        "payout": [
          {
            "id": 13,
            "event_name": "Batch submitted",
            "code": "batch_payout.created",
            "type": "payout",
            "description": "Batch submitted"
          },
          {
            "id": 14,
            "event_name": "Batch items paid successfully",
            "code": "batch_payout.completed",
            "type": "payout",
            "description": "Batch items paid successfully"
          },
          {
            "id": 15,
            "event_name": "Some batch items failed",
            "code": "batch_payout.partial",
            "type": "payout",
            "description": "Some batch items failed"
          }
        ]
      },
      "created_at": "2026-10-15T07:06:37.000Z",
      "updated_at": "2026-10-15T07:06:37.000Z"
    },
    {
      "id": 1,
      "url": "https://example.com/webhook",
      "secret_key": "Vp8OQjuHpwvqih^RR&3H",
      "event_ids": [
        13,
        14
      ],
      "events": {
        "payout": [
          {
            "id": 13,
            "event_name": "Batch submitted",
            "code": "batch_payout.created",
            "type": "payout",
            "description": "Batch submitted"
          },
          {
            "id": 14,
            "event_name": "Batch items paid successfully",
            "code": "batch_payout.completed",
            "type": "payout",
            "description": "Batch items paid successfully"
          }
        ]
      },
      "created_at": "2026-10-15T06:55:29.000Z",
      "updated_at": "2026-10-15T06:55:29.000Z"
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.