Get webhook

GET 
/v2/webhooks/:webhookId

Gets webhook object with all details.

Request

Path Parameters

webhookId string required
Webhook ID.

Example: Zib4xbZsmvZeK55ua

Status 200

Response Headers

{
  "data": {
    "id": "YiKoxjkaS9gjGTqhF",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "modifiedAt": "2019-12-13T08:36:13.202Z",
    "userId": "wRsJZtadYvn4mBZmm",
    "isAdHoc": false,
    "shouldInterpolateStrings": false,
    "eventTypes": [
      "ACTOR.RUN.SUCCEEDED"
    ],
    "condition": {
      "actorId": "hksJZtadYvn4mBuin",
      "actorTaskId": "asdLZtadYvn4mBZmm",
      "actorRunId": "hgdKZtadYvn4mBpoi"
    },
    "ignoreSslErrors": false,
    "doNotRetry": false,
    "requestUrl": "http://example.com/",
    "payloadTemplate": "{\\n \"userId\": {{userId}}...",
    "headersTemplate": "{\\n \"Authorization\": \"Bearer ...\"}",
    "title": "Actor run succeeded webhook",
    "description": "this is webhook description",
    "lastDispatch": {
      "status": "ACTIVE",
      "finishedAt": "2019-12-13T08:36:13.202Z"
    },
    "stats": {
      "totalDispatches": 1
    }
  }
}

Schema

• data object required

  • id string required
    Example: YiKoxjkaS9gjGTqhF
  • createdAt string<date-time> required
    Example: 2019-12-12T07:34:14.202Z
  • modifiedAt string<date-time> required
    Example: 2019-12-13T08:36:13.202Z
  • userId string required
    Example: wRsJZtadYvn4mBZmm
  • isAdHoc boolean | null nullable
    Example: false
  • shouldInterpolateStrings boolean | null nullable
    Example: false
  • eventTypes WebhookEventType (string)[] required

    Possible values: [ACTOR.BUILD.ABORTED, ACTOR.BUILD.CREATED, ACTOR.BUILD.FAILED, ACTOR.BUILD.SUCCEEDED, ACTOR.BUILD.TIMED_OUT, ACTOR.RUN.ABORTED, ACTOR.RUN.CREATED, ACTOR.RUN.FAILED, ACTOR.RUN.RESURRECTED, ACTOR.RUN.SUCCEEDED, ACTOR.RUN.TIMED_OUT, TEST]

    
    Example: ["ACTOR.RUN.SUCCEEDED"]
  • condition object required

    • actorId string | null nullable
      Example: hksJZtadYvn4mBuin
    • actorTaskId string | null nullable
      Example: asdLZtadYvn4mBZmm
    • actorRunId string | null nullable
      Example: hgdKZtadYvn4mBpoi
  • ignoreSslErrors boolean required
    Example: false
  • doNotRetry boolean | null nullable
    Example: false
  • requestUrl string<uri> required
    Example: http://example.com/
  • payloadTemplate string | null nullable
    Example: {\n "userId": {{userId}}...
  • headersTemplate string | null nullable
    Example: {\n "Authorization": "Bearer ..."}
  • title string | null nullable
    Example: Actor run succeeded webhook
  • description string | null nullable
    Example: this is webhook description
  • lastDispatch object

    anyOf
    • ExampleWebhookDispatch
    • null
    status WebhookDispatchStatus (string) required
    Status of the webhook dispatch indicating whether the HTTP request was successful.
    Possible values: [ACTIVE, SUCCEEDED, FAILED]
    finishedAt string<date-time> required
    Example: 2019-12-13T08:36:13.202Z
  • stats object

    anyOf
    • WebhookStats
    • null
    totalDispatches integer required
    Example: 1

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)