Webhooks/Webhook dispatches

Get webhook dispatch

Changed on

Gets webhook dispatch object with all details.

get/v2/webhook-dispatches/{dispatchId}

Request

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

Path parameters

dispatchIdstring required
Example:Zib4xbZsmvZeK55ua

Webhook dispatch ID.

Response

Example response

{
  "data": {
    "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

      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