Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Webhooks

List registered webhooks

This endpoint returns a list of responses received from a webhook URL for items passed through webhook stage. there are 20 per successful and 20 per failed responses recently received. Each of response contains response_code and response_body received on a webhook call. Returns up to 20 succeeded and failed webhook responses.

get/api/v2/teams/{team_slug}/webhooks/{workflow_id}/responses/{stage_id}

Path parameters

team_slugstring required

Team's sluggified name

workflow_idstring uuid required
Example:e23ff3f3-8f77-4e78-9e81-fdb25abfb781
stage_idstring uuid required
Example:e23ff3f3-8f77-4e78-9e81-fdb25abfb781

Response

WorkflowsV2.Webhook.WebhookResponses

Example response

{
  "failed": [
    {
      "filename": "my_image.jpg",
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "item_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ],
  "succeeded": [
    {
      "filename": "my_image.jpg",
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "item_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ]
}