Inserting a .pdf document in the notification header when creating the template
When you create a new template, you can define a document header. This documents needs to be a .pdf file that has to be publicly accessible from the web, and the link pointing to it mus start with https://.
WhatsApp templates created with our app
If you create the template using our app, you have the option to upload a document for the header (under Advanced Settings). This document will be publicly accessible from the web from an https:// link, and therefore usable in any WhatsApp template.
This document you upload when you create your template acts as a default; if you do not specify a document when sending your WhatsApp messages, that is the document that will be used.
WhatsApp templates created from the WhatsApp Administrator at the Facebook for Business website
You can also define a multimedia header when you define your template in the Facebook for Business (Meta) website:
Please note that the file you are asked to upload when creating the template is just an example; it will not be used as default.
If the document you want to send is accessible from the Internet, you will need the URL to access that document. Besides being publicly available, that URL needs to start with https://, and it must only point to a .pdf file. It cannot be a .docx, .txt or any other type of document.
Sending single notifications with a .pdf document
If you want to send them from a single notification, you need to:
- Select the header type: document (.pdf)
- Enter the header link: the value copied from the file upload, which will be at our server, or a valid URL of a document hosted elsewhere.
If you created the template using our app, when you select the template, the Link to resource will be pre-filled for you. You can change this link if you need to.
More information about sending notifications using Single Notifications here.
Sending notifications with .pdf files from an Excel or CSV file
If your Facebook template includes a pdf header, you need to include it in the file. In column ri_header_type, specify "document", and in column ri_header_link, specify the URL of the link.
If you created your template using our app, and you leave the ri_header_type and ri_header_link blank, the link specified in the template will be used by default.
More information about sending notifications using Excel or CSV files here.
Sending a .pdf file from a Zendesk trigger or by calling the API
If your Facebook template includes a pdf header, you must specify it in the your triggers, by adding the following parameters to the POST request:
- ri_header_type: "document"
- ri_header_link: Publicly available URL of the document, starting with https://
You can upload files to or server from the Media section, and then get their publicly available links from there to be used at the ri_header_link parameter, by clicking on the copy to clipboard button:
More information about using triggers here. You can find the technical documentation of our API here.
Sending a .pdf file from the ticket sidebar
If your Facebook template includes a pdf header, you must specify it in the form:
Leveraging templates
No matter which method you use to send your WhatsApp messages, using our app to create templates can help avoid errors and make your workflows safer and faster.
As stated before, you can specify the header type and link of that template at template creation. Those values will be used as default, so:
- When sending single notifications, from the app or from the ticket sidebar, the header values will be pre-filled with what you entered in the template.
- When uploading files and using triggers, if no header link is present, it will be used the one from the template. Therefore you don't need to include them every time, only when they change.
More information about templates here.