Webhooks/Webhooks

Gets webhook object with all details.

get/v2/webhooks/{webhookId}

Request

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

Path parameters

webhookIdstring required
Example:pVJtoTelgYUq4qJOt

Webhook ID.

Response

Example response

{
  "data": {
    "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/",
    "payloadTemplate": "{\\n \"userId\": {{userId}}...",
    "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

    • 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

      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