Trigger Push

post

https://endgrate.com/api/push/transfer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

endgrate_type

string

required

A valid endgrate_type for the session.

session_id

string

required

synchronous

boolean

Defaults to false

Whether or not to make this API request synchronous. If true, If true, Endgrate will poll the status of the transfer internally, and return only when the transfer is completed, with a 5 minute maximum polling time.

disable_upsert

string

Whether or not to disable automatic upsert and force Endgrate to create a new resource.

data_webhook

object

Endgrate will POST to this webhook whenever returned data is received. This is useful if you want to get returned data without polling the GET api/push/data endpoint.

completed_webhook

object

Endgrate will POST to this webhook whenever the transfer is completed.

error_webhook

object

Endgrate will POST to this webhook whenever an error occurs. This is useful if you want to get error information without polling the GET api/errors endpoint.

webhook_concurrency

boolean

Defaults to false

Whether or not to execute POST requests to webhooks concurrently.

sample_data

boolean

Defaults to false

Whether or not the data is marked as sample data only to be shown as an example during field selection.

transfer_data

array of objects

required

An array of transfer data to be pushed out.

transfer_data*

Responses

Callbacks

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError