Sign in
Notifications

Retrieve a callout template

Queries the callout template based on the specified ID. This operation supports retrieving the callout template for all event types.

get/notifications/callout-templates/{id}

Path parameters

idstring uuid required

The ID of the callout template.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Response

OK

activeboolean

The status of the callout template.

calloutBaseurlstring url

The callout URL.

calloutHeadersobject nullable

Container for custom callout headers. Each custom callout header consists of a header name and a header value.

calloutParamsobject nullable

Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.

calloutRetryboolean

Indicates whether to retry the callout when the callout fails.

certificatestring nullable

The SSL certificate for the domain of the callout receiver server specified in calloutBaseurl.

confirmSuccessFromResponseContentboolean

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.

contentTypestring

The callout body format.

createdBystring uuid

The ID of the user who created the callout template.

createdOnstring 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

customRequestBodystring nullable

Customized request body.

descriptionstring

Description for the callout template.

eventCategorynumber

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>.

eventTypeNamestring

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.

hmacDatastring nullable

The message to be authenticated for HMAC authentication.

hmacKeystring 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.

hmacSecretstring nullable

The shared secret key that Zuora uses to generate the signed data for HMAC authentication.

hmacValuestring 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.

idstring uuid

The ID of the callout template.

namestring

The name of the callout template.

oauth2ProviderIdstring nullable

The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout.

requiredAuthboolean

Indicates whether Basic authentication is enabled for the callout.

requiredOauth2boolean

Indicates whether OAuth 2.0 authentication is enabled for the callout.

updatedBystring uuid

The ID of the user who updated the callout template.

updatedOnstring 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

useCustomRequestBodyboolean

Indicates whether to enable the customized request body configured in the customRequestBody field.

Example response

{
  "calloutBaseurl": "https://***",
  "httpMethod": "POST"
}

Changes