---
title: "List callout templates"
method: GET
path: "/notifications/callout-templates"
tags: ["Notifications"]
---

# List callout templates

`GET /notifications/callout-templates`

Queries callout templates. This operation supports querying callout templates for all event types.

## Query parameters

- `start` integer
- `limit` integer
- `eventCategory` number
- `eventTypeName` string
- `name` string

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string

## Response `200`

OK

- object
  - `data` GETPublicCalloutTemplateResponse[]
    - `active` boolean — The status of the callout template.
    - `calloutAuth` CalloutAuth, nullable — If `requiredAuth` is `true`, this object is required.
      - `domain` string — The domain of the callout auth.
      - `password` string — The field is required when `requiredAuth` is `true`.
      - `preemptive` boolean — Set this field to `true` if you want to enable the preemptive authentication.
      - `username` string — The field is required when `requiredAuth` is `true`.
    - `calloutBaseurl` string, url — The callout URL.
    - `calloutHeaders` object, nullable — Container for custom callout headers. Each custom callout header consists of a header name and a header value.
    - `calloutParams` object, nullable — Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.
    - `calloutRetry` boolean — Indicates whether to retry the callout when the callout fails.
    - `certificate` string, nullable — The SSL certificate for the domain of the callout receiver server specified in `calloutBaseurl`.
    - `confirmSuccessFromResponseContent` boolean — Indicates how Zuora determines whether callout notifications to your system succeed or fail: * If `false`, Zuora determines the result based solely on the HTTP response status code. This is the default value. * If `true`, and the HTTP response status code is 200, Zuora evaluates the callout response and considers the notification successful only if the `Content-Type` header is set to `application/json`, and the response body contains a `success` field set to `true`.
    - `contentType` string — The callout body format.
    - `createdBy` string, uuid — The ID of the user who created the callout template.
    - `createdOn` string, date-time — The time when the callout template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00
    - `customRequestBody` string, nullable — Customized request body.
    - `description` string — Description for the callout template.
    - `eventCategory` number — The event category code for the standard event that the callout template relates to. This field is available only if the related event of this callout template is a standard event. For the list of supported standard event category codes, see <a href="https://docs.zuora.com?resourceId=platform-parent-and-event-category-code" target="_blank">Standard event category code for events and notifications</a>.
    - `eventTypeName` string — The name of the custom event that the callout template relates to. This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event.
    - `eventTypeNamespace` 'user.notification' | 'com.zuora.notification' — The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to. Supported values are as follows: - `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events. - `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value. This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event.
    - `hmacAlgorithm` 'MD5' | 'SHA-1' | 'SHA-224' | 'SHA-256' | 'SHA-384' | 'SHA-512' | 'null', nullable — The hash function Zuora uses to generate the signed data for HMAC authentication.
    - `hmacData` string, nullable — The message to be authenticated for HMAC authentication.
    - `hmacKey` string, nullable — The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the `hmacValue` field and typically contains the signed data.
    - `hmacOutputFormat` 'BASE64' | 'HEX' | 'null', nullable — The format of the signed data for HMAC authentication.
    - `hmacSecret` string, nullable — The shared secret key that Zuora uses to generate the signed data for HMAC authentication.
    - `hmacValue` string, nullable — The header value for HMAC authentication. The header key is specified in the `hmacKey` field.
    - `httpMethod` 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' — The HTTP method of the callout.
    - `id` string, uuid — The ID of the callout template.
    - `name` string — The name of the callout template.
    - `oauth2ProviderId` string, nullable — The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout.
    - `requiredAuth` boolean — Indicates whether Basic authentication is enabled for the callout.
    - `requiredOauth2` boolean — Indicates whether OAuth 2.0 authentication is enabled for the callout.
    - `updatedBy` string, uuid — The ID of the user who updated the callout template.
    - `updatedOn` string, date-time — The time when the callout template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00
    - `useCustomRequestBody` boolean — Indicates whether to enable the customized request body configured in the `customRequestBody` field.
  - `next` string — The URI to query the next page of data, e.g. '/notifications/callout-templates?start=21&limit=20'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `405` — Method Not Allowed
- `415` — Unsupported Media Type
- `500` — Internal Server Error

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)