Get list of webhook dispatches
Changed onGets the list of webhook dispatches that the user have.
The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000 records. By default, the records are sorted by the createdAt field in ascending order. To sort the records in descending order, use the desc=1 parameter.
Request
- Base URLhttps://api.apify.com
- Auth
- HTTP bearer
- or API key in query parameter token
Query parameters
Number of items that should be skipped at the start. The default value is 0.
Maximum number of items to return. The default value as well as the maximum is 1000.
If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.
Response
Example response
{
"data": {
"total": 1,
"limit": 1000,
"count": 1,
"items": [
{
"id": "asdLZtadYvn4mBZmm",
"userId": "wRsJZtadYvn4mBZmm",
"webhookId": "asdLZtadYvn4mBZmm",
"createdAt": "2019-12-12T07:34:14.202Z",
"eventData": {
"actorId": "vvE7iMKuMc5qTHHsR",
"actorRunId": "JgwXN9BdwxGcu9MMF",
"actorBuildId": "HG7ML7M8z78YcAPEB",
"actorTaskId": "zRLp8SDOZz2NyLg7K"
},
"webhook": {
"_id": "YiKoxjkaS9gjGTqhF",
"actionType": "HTTP_REQUEST",
"condition": {
"actorId": "hksJZtadYvn4mBuin",
"actorTaskId": "asdLZtadYvn4mBZmm",
"actorRunId": "hgdKZtadYvn4mBpoi"
},
"requestUrl": "https://example.com/webhook",
"slackMessage": {
"userIntegrationId": "kLcd8Z4dzXN1z3QzS",
"channelId": "C01234ABCDE",
"messageTemplate": "Actor run {{resource.id}} finished."
},
"googleMail": {
"userIntegrationId": "kLcd8Z4dzXN1z3QzS",
"emailTo": [
"bob@example.com"
],
"subject": "Actor run finished",
"body": "Actor run {{resource.id}} finished.",
"attachmentFormat": "csv",
"attachmentTransformation": {
"fields": [
"title",
"url"
],
"omit": [
"html"
]
}
},
"googleDrive": {
"userIntegrationId": "kLcd8Z4dzXN1z3QzS",
"filename": "results",
"format": "json",
"transformation": {
"fields": [
"title",
"url"
],
"omit": [
"html"
]
}
},
"githubIssue": {
"userIntegrationId": "kLcd8Z4dzXN1z3QzS",
"repository": "apify/apify-docs",
"title": "Actor run failed",
"body": "Actor run {{resource.id}} failed."
}
},
"calls": [
{
"startedAt": "2019-12-12T07:34:14.202Z",
"finishedAt": "2019-12-12T07:34:14.202Z",
"errorMessage": "Cannot send request",
"responseStatus": 200,
"responseBody": "{\"foo\": \"bar\"}"
}
]
}
]
}
}Changes
- info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status
- info
- info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status
- info