> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.withpersona.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server. # List all Webhooks GET https://api.withpersona.com/api/v1/webhooks Returns a list of your environment's webhooks. Results are returned in reverse chronological order, with the most recently created objects first. Reference: https://docs.withpersona.com/api-reference/webhooks/list-all-webhooks ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `page` (WebhooksGetParametersPage, optional) - `fields` (map from string to string, optional) — Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. ### Headers - `Key-Inflection` (enum, optional) — Determines casing for the API response. - Allowed values: `camel`, `kebab`, `snake` - `Idempotency-Key` (string, optional) — Ensures the request is idempotent. - `Persona-Version` (enum, optional) — Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). - Allowed values: `2025-12-08`, `2025-10-27`, `2023-01-05`, `2022-09-01`, `2021-08-18`, `2021-07-05`, `2021-02-21`, `2020-05-18` ## Response ### 200 This endpoint returns a collection of Webhook objects. - `data` (list of webhook, required) — An array of Webhooks - `links` (WebhooksGetResponsesContentApplicationJsonSchemaLinks, required) ## Errors ### 400 Bad Request Error The request was unacceptable, often due to invalid parameters. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 401 Unauthorized Error An invalid API key was provided. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 403 Forbidden Error The given API key doesn’t have permissions to perform the request or a quota has been exceeded. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 429 Too Many Requests Error Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ## Types ### WebhooksGetParametersPage - `after` (string, optional) — Object ID for pagination cursor - `before` (string, optional) — Object ID for pagination cursor - `size` (double, optional) — Limit on the number of objects returned ### webhook A Webhook object - `type` ("webhook", optional) - `id` (string, optional) - `attributes` (WebhookAttributes, optional) ### WebhooksGetResponsesContentApplicationJsonSchemaLinks - `next` (string, required, nullable) - `prev` (string, required, nullable) ### WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems - `title` (string, optional) - `details` (string, optional) ### WebhookAttributes - `status` (string, optional) - `url` (string, optional) - `name` (string, optional, nullable) - `description` (string, optional, nullable) - `api-version` (enum, optional) — Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). - Allowed values: `2025-12-08`, `2025-10-27`, `2023-01-05`, `2022-09-01`, `2021-08-18`, `2021-07-05`, `2021-02-21`, `2020-05-18` - `api-key-inflection` (string, optional) - `api-attributes-blocklist` (list of string, optional) - `file-access-token-expires-in` (integer, optional) - `enabled-events` (list of string, optional) - `payload-filter` (WebhookAttributesPayloadFilter, optional, nullable) - `included-allowlist` (included-allowlist, optional, nullable) — Controls which related objects appear in the `included` array of webhook payloads. The default is `include_none`. When `state` is `custom`, `event-types` configures which related objects to include per event type: event types you are subscribed to (via `enabled-events`) but do not list are excluded, and event types you list but are not subscribed to are dropped on save. A `custom` config whose event types are all `["*"]` is equivalent to, and is normalized to, `include_all`. - `relationship-allowlist` (relationship-allowlist, optional) — Controls whether relationships are serialized in webhook payload objects. The default is `include_all`. The object shape leaves room for future granular relationship configuration. - `created-at` (datetime, optional) ### WebhookAttributesPayloadFilter ### included-allowlist Controls which related objects appear in the `included` array of webhook payloads. The default is `include_none`. When `state` is `custom`, `event-types` configures which related objects to include per event type: event types you are subscribed to (via `enabled-events`) but do not list are excluded, and event types you list but are not subscribed to are dropped on save. A `custom` config whose event types are all `["*"]` is equivalent to, and is normalized to, `include_all`. ### relationship-allowlist Controls whether relationships are serialized in webhook payload objects. The default is `include_all`. The object shape leaves room for future granular relationship configuration. ### Include all - `state` ("include_all", required) — Include all related objects for every subscribed event type. ### Include none - `state` ("include_none", required) — Include no related objects (the default). ### Custom - `state` ("custom", required) — Configure included related objects per event type via `event-types`. - `event-types` (list of IncludedAllowlistOneOf2EventTypesItems, required) — Per-event-type include configuration. At most one entry per event type. ### Include all - `state` ("include_all", required) — Include relationship linkages in webhook payload objects. ### Include none - `state` ("include_none", required) — Omit relationship linkages from webhook payload objects. ### IncludedAllowlistOneOf2EventTypesItems - `event-type` (string, required) — Event type identifier (e.g. `inquiry`, `account`). - `relationships` (list of string, required) — Related object names to include for this event type, or `["*"]` to include all related objects. `"*"` cannot be combined with named relationships. ## Examples **Response** ```json { "data": [ { "type": "webhook", "id": "wbh_ABC123", "attributes": { "status": "disabled", "url": "https://withpersona.com", "api-version": "2023-01-05", "api-key-inflection": "kebab", "api-attributes-blocklist": [ "address-*", "name-last", "/data/attributes/fields/*-number" ], "file-access-token-expires-in": 21600, "enabled-events": [ "account.created", "verification.created" ], "payload-filter": { "data": { "relationships": { "inquiry-template": { "data": { "id": "itmpl_abc123def456" } } } } }, "created-at": "2023-08-17T23:18:13.000Z" } }, { "type": "webhook", "id": "wbh_ABC123", "attributes": { "status": "disabled", "url": "https://withpersona.com", "api-version": "2023-01-05", "api-key-inflection": "camel", "api-attributes-blocklist": [ "/data/attributes/fields/*-number" ], "file-access-token-expires-in": 600, "enabled-events": [ "*" ], "payload-filter": {}, "created-at": "2023-09-18T23:18:13.000Z" } } ], "links": { "next": null, "prev": null } } ``` **SDK Code** ```python Success import requests url = "https://api.withpersona.com/api/v1/webhooks" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Success const url = 'https://api.withpersona.com/api/v1/webhooks'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Success package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.withpersona.com/api/v1/webhooks" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Success require 'uri' require 'net/http' url = URI("https://api.withpersona.com/api/v1/webhooks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Success import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.withpersona.com/api/v1/webhooks") .header("Authorization", "Bearer ") .asString(); ``` ```php Success request('GET', 'https://api.withpersona.com/api/v1/webhooks', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Success using RestSharp; var client = new RestClient("https://api.withpersona.com/api/v1/webhooks"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Success import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.withpersona.com/api/v1/webhooks")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```