APapify
Webhooks/Webhooks

Get list of webhooks

Changed on

Gets the list of webhooks that the user created.

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.

get/v2/webhooks

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Query parameters

offsetnumber double

Number of items that should be skipped at the start. The default value is 0.

limitnumber double
Example:1000

Maximum number of items to return. The default value as well as the maximum is 1000.

descboolean
Example:true

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": "YiKoxjkaS9gjGTqhF",
        "createdAt": "2019-12-12T07:34:14.202Z",
        "modifiedAt": "2019-12-13T08:36:13.202Z",
        "userId": "wRsJZtadYvn4mBZmm",
        "isEnabled": true,
        "actionType": "HTTP_REQUEST",
        "eventTypes": [
          "ACTOR.RUN.SUCCEEDED"
        ],
        "condition": {
          "actorId": "hksJZtadYvn4mBuin",
          "actorTaskId": "asdLZtadYvn4mBZmm",
          "actorRunId": "hgdKZtadYvn4mBpoi"
        },
        "requestUrl": "http://example.com/",
        "headersTemplate": "{\\n \"Authorization\": \"Bearer ...\"}",
        "title": "Notify on failure",
        "description": "this is webhook description",
        "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."
        },
        "lastDispatch": {
          "finishedAt": "2019-12-13T08:36:13.202Z"
        },
        "stats": {
          "totalDispatches": 1
        }
      }
    ]
  }
}

Changes

  • ec76185eb934Revision 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

  • e52dd2239ceeRevision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became optional for 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

      added the optional property //// to the response with the status