Submit a request Sign In

Home > FAQs > What are HTTP methods to write server scripts?

FAQs in this section

What is VTAP? What tools VTAP provides? What is Module Designer? What is API Designer? Where can I find documentation for VTAP? Which editions and version supports VTAP? What is the pricing of VTAP? What happens to customization done using Customizer in V7 version? How to get in touch with Platform team? What is the intent of Developer edition? What is Vtiger’s Add-on Publisher? Is Add-ons Publisher available in all the CRM editions? How do I publish Email Template add-ons? How do I publish any other module as an add-on? How do I update a published add-on? How do I test an add-on? What are the limitations of the Add-ons Publisher? Which different add-on features can I publish? What can a developer publish using Add-on Publisher? What are the conditions for updating a published add-on? What are the prerequisites for publishing an add-on? What is an Insights Designer? What is the use of Insigts Designer in Vtiger CRM? What are the queries in Insights Designer? What are the components of the Insight Designer? What are the components of a Widget in Insights Designer? What is the Input tab in Insights Designer? What is the Transfer tab in Insights Designer? What is the Output tab in Insights Designer? What are the benefits of using the Insights Designer? How do I access the Insights Designer in Vtiger CRM? How do I create an Insights page? How do I enable filters for a report? How do I pin an Insight to the Dashboard? Is Raw Query support available by default? In which editions of Vtiger CRM is the VTAP - App Creator available? Can I set access to my custom apps? What are Line Item Fields in Insights Designer? What are Server Scripts and Jobs in Vtiger CRM? What is a Server Script? What are Server jobs? How do I create a Server job? What are the different helper methods to write server scripts? What is the Debugging method to write Server scripts? What is Vtiger REST API method to write server scripts? How to write code for Server Scripts and Jobs? How to write a script for a server job to update stocks weekly in the warehouse system? How to write a script for a server job for importing daily leads from a file? How to write a server script to set case SLA by created day? How to write a server script to calculate the outstanding invoice amount? How to write a server script for contact email validation and data enrichment? how to write a server script to update the credit score of a contact? How can I delete a UI component in the Module Designer?

What are HTTP methods to write server scripts?

Table of Contents

HTTP request methods (vtap.macro.http)

Methods include sending requests and receiving responses.
Two parameters for all methods -
- URL (mandatory)
- Options (optional, for additional request details like headers, query strings, request body, form data, etc).
Methods are asynchronous and return a promise, therefore it must be used with await.
The provided methods are as below -
- GET (vtap.macro.http.get)

Example

var response = await vtap.macro.http.get(‘https://www.mywebsite.com’, {
headers: {
Authorization: ‘XXXXXXXXXXXXXXXXXX’
},
qs: {
key1: ‘Value1’,
key2: ‘Value2’
}
});

POST (vtap.macro.http.post)

Example

var response = await vtap.macro.http.post(‘https://www.mywebsite.com’, {
headers: {
CUSTOM_HEADER_KEY: ‘HEADER VALUE’
},
body: {
key1: ‘Value 1’,
key2: ‘Value 2’
},
json: true
});

PUT (vtap.macro.http.put)

Example

var response = await vtap.macro.http.put(‘https://www.mywebsite.com’, {
formData: {
key1: ‘Value 1’,
key2: ‘Value 2’
}
});

PATCH (vtap.macro.http.patch)

Example

var response = await vtap.macro.http.patch(‘https://www/mywebsite.com’);

DELETE (vtap.macro.http.delete)

Example

var response = await vtap.macro.http.delete(‘https://www.mywebsite.com’);

Constraints:

Only HTTPS URLs with valid SSL certificates are allowed for sending requests.
Insecure URLs, direct IPs (e.g., 127.0.0.1), and localhost are not permitted.
Requests to any Vtiger’s domain are restricted, except for the instance URL where the code is executed.
To handle request failures, use try-catch blocks.
Place requests inside try blocks, and catch any errors for troubleshooting.
Use try-catch to handle failed webservice requests.
Place the requests inside the try block.
If a request fails, the error will be available in the catch section for troubleshooting.

Was this FAQ helpful?

0 out of 0 found this helpful.

Comments 0

Be the first to comment

Home

Privacy Policy

Terms of Service

Security Center

Policy & Legal Center

Contact Us

© Copyright 2023 Vtiger. All rights reserved.

Powered by Vtiger