Connectors, API & on-premise reach — found from sitemap — Zapier

Cited by

Facts read from this source

• Two request styles Report an error

  “There are two ways to make HTTP requests: Shorthand HTTP requests - Easy to use, but limits what you can control. Best for simple requests. Manual HTTP requests - Gives you full control over the request and response.”

• Middleware helpers Report an error

  “requestTemplate - an object literal of HTTP request options that will be merged with every request. beforeRequest - middleware that mutates every request before it is sent. afterResponse - middleware that mutates every response before it is completed.”

• Shorthand features Report an error

  “This features: Lazy {{curly}} replacement. JSON and form body de-serialization. Automatic non-2xx error raising.”

• Shorthand parse error Report an error

  “An error will be raised if the response cannot be parsed as JSON or form-encoded.”

• Manual use cases Report an error

  “To do processing (usually involving bundle.inputData) before a request is made. To do processing of an API’s response before you return data to Zapier. To process an unusual response type, such as XML.”

• Curlies v17 removal Report an error

  “Since v17, z.request() no longer replaces {{var}} and will throw an error if there’s {{var}} in the request object.”

• Body auto serialize Report an error

  “You don’t need to serialize your request data using JSON.stringify() before setting the body. z.request() does that for you.”

• Middleware lifecycle Report an error

  “set defaults on the request object run your beforeRequest middleware functions in order add applicable auth headers (e.g. adding Basic ... for basic auth), if applicable add request.params to request.url execute the request, store the result in response try to auto-parse response body for non-raw requests, store result in response.data log the request to Zapier’s logging server”

• Refresh auth error Report an error

  “if the status code is 401, you’re using a refresh-able auth (such as oauth2 or session) and autoRefresh is true in your auth configuration, throw a RefreshAuthError. The server will attempt to refresh the authentication again and retry the whole step”

• Skip throw for status Report an error

  “However, you can disable automatic error throwing by setting skipThrowForStatus on the request object”

• Throw for stale auth Report an error

  “In v12.x, we brought back the built-in throwForStaleAuth middleware that throws z.errors.RefreshAuthError when a 401 Unauthorized response is received and your authentication supports auto-refresh (such as oauth2 or session auth).”

• Throw for throttling Report an error

  “In v18.x, we added a built-in throwForThrottling middleware that throws z.errors.ThrottledError when a 429 Too Many Requests response is received. ThrottledError tells Zapier to retry the request after some time.”

• Throttling disable option Report an error

  “This means in ≥ v18 you’d never see a 429 response in your afterResponse middleware, unless you set throwForThrottlingEarly to false globally or in the z.request() options.”

• Request options Report an error

  “url: HTTP url, you can provide it as a separate argument (z.request(url, options)) or as part of the options object (z.request({url: url, ...})). method: HTTP method, default is GET. headers: request headers object, format {'header-key': 'header-value'}. params: URL query params object, format {'query-key': 'query-value'}.”

• Timeout default Report an error

  “timeout: request / response timeout in ms. Set to 0 to disable (OS limit still applies), timeout reset on redirect. Default is 0 (disabled).”

• Follow redirects default Report an error

  “follow: maximum redirect count, set to 0 to not follow redirects. default is 20.”

• Compress default Report an error

  “compress: support gzip/deflate content encoding. Set to false to disable. Default is true.”

• Response object Report an error

  “status: The response status code, i.e. 200, 404, etc. content: The response content as a String. For Buffer, try options.raw = true. data (added in v10.0.0): The response content as an object if the content is JSON or application/x-www-form-urlencoded (undefined otherwise).”

• Throw for status range Report an error

  “throwForStatus(): Throws an error if 400 <= statusCode < 600.”

• Raw response stream Report an error

  “raw: set this to stream the response instead of consuming it immediately. Default is false.”

• Custom http client discouraged Report an error

  “You can install any HTTP client you like—but this is discouraged as you might lose automatic HTTP logging and middleware.”

• Middleware no z request Report an error

  “The second argument for middleware is the z object, but it does not include z.request() as using that would easily create infinite loops.”

1 fact read from this page is not shown because it could not be confirmed on the page as captured.

Scores citing this record

• The Data Protection Officer Connectors, API & on-premise reach
• The Data Protection Officer Connectors, API & on-premise reach
• The Data Protection Officer Execution, error handling & monitoring
• The Head of IT Connectors, API & on-premise reach
• The Head of IT Execution, error handling & monitoring
• The Head of IT Connectors, API & on-premise reach
• The Head of IT Execution, error handling & monitoring
• The Integration Engineer Execution, error handling & monitoring
• The Integration Engineer Connectors, API & on-premise reach
• The Integration Engineer Execution, error handling & monitoring
• The Operations Analyst Execution, error handling & monitoring
• The Operations Analyst Connectors, API & on-premise reach
• The Operations Analyst Execution, error handling & monitoring
• The Process Owner Execution, error handling & monitoring
• The Process Owner Execution, error handling & monitoring
• The Skeptic Connectors, API & on-premise reach
• The Skeptic Execution, error handling & monitoring
• The Skeptic Connectors, API & on-premise reach