---
title: "About Outbound Templates"
canonical: "https://docs.infoblox.com/space/nios85/35914697/About%20Outbound%20Templates"
format: markdown
---
The appliance uses outbound templates to convert NIOS events into REST API, DXL, and Syslog messages. Outbound API templates control the integration and contains necessary steps to execute  outbound notifications. Infoblox supports session management and action templates that are available in the Infoblox Community Site at <span style="color: #0000ff">[*https://community.infoblox.com*](https://community.infoblox.com/)</span>. You can either modify these existing templates or create new ones through Grid Manager using the existing templates. You use supported variables in these templates to get respective events and define actions you want to take for those events. You can also define additional extensible attributes that are necessary for certain templates.The appliance uses the scripts in these templates to process and send outbound notifications to the endpoints.

The following are the outbound templates that you can create:

- ** Session Management Template**: A session management template contains specific variables about an endpoint, such as the timeout value and rate limiting information. For more information, see *<span style="color: #0000ff">[Creating](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Session](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Management](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Templates](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*.
- **Action Template**: An action template defines the action(s) to be taken on the selected endpoint for the matching event type(s). It contains scripts the appliance uses to query respective event data from NIOS and to perform actions you want to take in response to the events. For more information, see *<span style="color: #0000ff">[Creating](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[Action](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[Templates](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*.

> ⚠️ **Note**
> ⚠️ 
> ⚠️ When you add an outbound template or make changes to an existing one, it may take a few seconds to a few minutes until the changes are propagated to all the members.

You can also export the schema from the appliance and use it to create the outbound templates. For information about how to export template schema, see *<span style="color: #0000ff">[Exporting](#AboutOutboundTemplates-bookmark3409)</span>*<span style="color: #0000ff">[ ](#AboutOutboundTemplates-bookmark3409)</span>*<span style="color: #0000ff">[Template](#AboutOutboundTemplates-bookmark3409)</span>*<span style="color: #0000ff">[ ](#AboutOutboundTemplates-bookmark3409)</span>*<span style="color: #0000ff">[Schema](#AboutOutboundTemplates-bookmark3409)</span>*. Note that the exported schema is in the IETF JSON Schema format. For information about this schema format, see <span style="color: #0000ff">[*https://tools.ietf.org/html/draft-zyp-json-schema-04*](https://tools.ietf.org/html/draft-zyp-json-schema-04_)</span><span style="color: #0000ff">[*.*](https://tools.ietf.org/html/draft-zyp-json-schema-04)</span>

> ⚠️ **Note**
> ⚠️ 
> ⚠️ To access online resources about this feature, including training videos and sample outbound templates for supported ecosystem partners, visit the Infoblox Community Site at <span style="color: #0000ff">[*https://community.infoblox.com*](https://community.infoblox.com/)</span>.


# > Macro (anchor)

> Macro (anchor)

Adding Outbound Templates

You can use the supported templates that are available in the Infoblox Community Site at <span style="color: #0000ff">[*https://community.infoblox.com*](https://community.infoblox.com/)</span>. You can download these templates make necessary changes and upload them to the Infoblox Grid.

Complete the following to add or upload an outbound template to the Infoblox Grid:

1. **Grid**: From the **Grid** tab, select the **Ecosystem** tab -> **Templates** tab, and then click the Add icon.   
or  
From the **Grid** tab, select the **Ecosystem** tab, and click **Add** **Template** from the Toolbar.  
**System**: From the **System** tab, select the **Ecosystem** tab -> **Templates** tab, and then click the Add icon.   
or  
From the **System** tab, select the **Ecosystem** tab, and click **Add** **Template** from the Toolbar.
2. In the *Add* *Template* wizard, complete the following:

> Macro (legacy-content)

3. Click **Add** to add an outbound template. To add a session management template, see *<span style="color: #0000ff">[Creating](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Session](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Management](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Templates](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>* or *<span style="color: #0000ff">[Creating](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[Action](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[Templates](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>* to create an action template. 

4. Optionally, click **View**** Results** to open the *Syslog** Preview* dialog and view all the syslog messages. For more information, see *<span style="color: #0000ff">[Previewing](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35480883/Status+Dashboard#StatusDashboard-PreviewingSyslogEvents)</span>*[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35480883/Status+Dashboard#StatusDashboard-PreviewingSyslogEvents)*<span style="color: #0000ff">[Syslog](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35480883/Status+Dashboard#StatusDashboard-PreviewingSyslogEvents)</span>*[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35480883/Status+Dashboard#StatusDashboard-PreviewingSyslogEvents)*<span style="color: #0000ff">[Events](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35480883/Status+Dashboard#StatusDashboard-PreviewingSyslogEvents)</span>*.

# > Macro (anchor)

> Macro (anchor)

Modifying Outbound Templates

To modify an outbound template:

1. **Grid**: From the **Grid** tab, select the **Ecosystem** tab -> **Templates** tab -> *template* checkbox, and then click the Edit icon.  
or  
From the **Grid** tab, select the **Ecosystem** tab, select the template that you want to modify, click the Action icon
  and select **Edit**.  
**System**: From the **System** tab, select the **Ecosystem** tab -> **Templates** tab -> *template* checkbox, and then click the Edit icon.  
or  
From the **System** tab, select the **Ecosystem** tab, select the template that you want to modify, click the Action icon and select **Edit**.
2. The *<Template Name>Template* editor contains the following tabs from which you can modify information:
  - **General**: You can modify the **Name** and **Comment** fields. All other fields are automatically propagated with available information, such as the template type, vendor type, event type, and action type. The **Name** field is optional for NIOS 8.3.0 and later releases, but note that it is mandatory for jump operations. When you do not specify a name for the template, an auto-generated value is set for this field. Example: `templatestep#N` or `functionstep#N` where N represents the step number. When you import a template, ensure that the goto functions are sent to named steps and not to automatically named steps.
  - **Contents**: This tab displays the content of the uploaded template file. You can modify the template contents and the appliance validates the content for proper JSON format when you save the configuration. For more information about the format of the templates, see *<span style="color: #0000ff">[Creating](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Session](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Management](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>*<span style="color: #0000ff">[Templates](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35849904)</span>* and *<span style="color: #0000ff">[Creating](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[Action](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[ ](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*<span style="color: #0000ff">[Templates](https://infoblox-docs.atlassian.net/wiki/spaces/nios85/pages/35915235)</span>*.
3. Save the configuration.

# > Macro (anchor)

> Macro (anchor)

Viewing All Outbound Templates

To view the list of outbound templates:

1. **Grid**: From the **Grid** tab, select the **Ecosystem** tab, and then click the **Templates** tab.  
**System**: From the **System** tab, select the **Ecosystem** tab, and then click the **Templates** tab.
2. Grid/System Manager displays the following information:
  - **Name**: The outbound template name.
  - **Vendor** **Type**: The vendor type.
  - **Event** **Type**: The event type specified in the template.
  - **Template** **Type**: Displays the template type, such as **Session** **Management** or **Action **template.
  - **Outbound Type**: The endpoint type. This can be REST, DXL, or Syslog.
  - **Comment**: Comments that were entered for the outbound template.
  - **Added** **On**: Displays the timestamp when the template was uploaded to the Grid Master in this format: YYYY-MM-DD HH:MM:SS, plus time zone.

You can do the following in this tab:

- You can select the Action icon
  and do the following:
  - **Edit**: Select this to modify the outbound template information.
  - **Delete**: Select this to delete a template.
  - **Export**: Select this to export a template.
- Edit the outbound template information.
  - Select the outbound template, and then click the Edit icon.
- Delete an outbound template.
  - Select the template, and then click the Delete icon.
- Export the list of outbound templates.
  - Click the Export icon.
- Print the list of outbound templates.
  - Click the Print icon.
- Use filters and the **Go ****to** function to narrow down the list. With the autocomplete feature, you can just enter the first few characters of an object name in the **Go ****to** field and select the object from the possible matches.
- Create a quick filter to save frequently used filter criteria:

> Macro (legacy-content)

- Sort the outbound templates in ascending or descending order by column.

# > Macro (anchor)

> Macro (anchor)

Deleting Outbound Templates

You can delete a template anytime after you have created it.

> ⚠️ **Note**
> ⚠️ 
> ⚠️ Before you delete a template, ensure that it is not in use by a notification or an endpoint.


To delete a template:

1. From the **Grid/System** tab, select the **Ecosystem** tab, and then click the **Templates** tab.
2. Select the template that you want to delete, and click the Delete icon.
3. Click **Yes** in the *Delete* *Confirmation* dialog.

# > Macro (anchor)

> Macro (anchor)

Exporting Template Schema

The Export Template Schema feature allows you to export the session management and action template schema. You can use the exported schema to validate the templates before uploading them. The exported schema is in IETF JSON Schema format. It is a JSON file that is used to define and validate outbound templates that you want to upload to the appliance. If you want to create your own templates, you must follow this schema format. For information about this format, see <span style="color: #0000ff">[*https://tools.ietf.org/html/draft-zyp-json-schema-04*](https://tools.ietf.org/html/draft-zyp-json-schema-04_)</span>.  
Complete the following to export the outbound template schema:

1. From the **Grid/System** tab, select the **Ecosystem** tab -> select the **Templates** tab.
2. Expand the Toolbar, click **Export**** Template**** Schema** -> select **Action ****Template**** Schema** to export the action template schema or select **Session**** Template ****Schema** to export the session management template schema.
3. If there is only one template version, the appliance downloads the schema to your local system. If there are multiple template versions, the appliance displays the *Export **Action **Template **Schema* or *Export **Session **Template **Schema* dialog. In the dialog, select the outbound template and the template version that you want to export. The template schema is downloaded to your local system.