If you’re looking to programmatically create UI’s/forms to POST Ticket, this is the article for you! We'll cover all the basics from using the /meta endpoint to POST, some best practices, and integration-specific tips!
Using /meta
If you’re looking to programmatically create UI’s/forms to POST Ticket, our /meta endpoint does the job! The /meta endpoint allows you to programmatically pull required fields & available enum options, based on the linked account & integration. We do all the work for you so that you don’t have to.
Here are some of our docs that you can understand what parameters you can enter as well as the request_schema that shows what the required fields are!
Postman
We have a doc for using Postman and Merge and a public Merge Postman collection for our Unified API. In our public collection, navigate to Merge Ticketing API -> tickets folder -> /POST tickets.
Some tips and reminders!
Make sure your
Authorization TypeisBearerand that you're passing in your Merge API Key. Depending on the type of Linked Account that you are using, it can be a Production or Test key.Make sure that your
account-tokenis set in your request headers. Our public Postman collection automatically passes the environment variables into the request headers underX-Account-Token. You can also pass it.Make sure that
content-typeisapplication/jsonIf you are passing in
rawunderbody, make sure that the Body Type isJSON
POST Tickets
To POST Ticket, you will need to use our /meta endpoint to identify the required fields for POSTing a Ticket for your integration. In some cases, you will also use the integration_params field in your request body, which stands for integration-specific parameters that can be utilized to POST a ticket.
Once your customer has selected the rest of the available fields, you can POST /ticket!
Here's a sample payload that we used to create a new ticket in ServiceNow!
{
"model": {
"name": "An incident created by Merge",
"ticket_type": "incident",
"integration_params": {
"category": "software",
"subcategory": "email",
"urgency": "1",
"impact": "1"
}
}
}PATCH Tickets
Similarly, you can use the /meta endpoint and then PATCH /ticket.