Skip to content
TeamGrid Developer

Get webhook delivery metadata

GET
/webhook-deliveries/{id}
curl --request GET \
  --url https://api.de.teamgrid.app/v1/webhook-deliveries/example \
  --header 'Authorization: Bearer <token>'

Returns a credential-owned delivery after the cell-local App reapplies credential ownership and workspace isolation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 256 characters /^[A-Za-z0-9_-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The requested resource.

Media typeapplication/json
object
data
required

Credential-owned webhook delivery metadata. Destination URLs, request and response payloads, headers, bodies, secrets, tenant routing, and retention fields are never exposed.

object
attributes
required
object
attemptCount
required
integer
>= 1 <= 32
attempts
required
Array<object>
>= 1 items <= 32 items
object
attempt
required
integer
>= 1 <= 32
errorCode
required
string | null
Allowed values: http_error transport_error
finishedAt
required
string | null format: date-time
startedAt
required
string format: date-time
state
required
string
Allowed values: delivering failed retrying skipped succeeded
statusCode
required
integer | null
>= 100 <= 599
transportCode
required
string | null
<= 64 characters /^[A-Za-z0-9_.:-]+$/
collection
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
completedAt
required
string | null format: date-time
createdAt
required
string format: date-time
deliveryId
required
string
>= 1 characters <= 256 characters /^[A-Za-z0-9_-]+$/
event
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
resourceId
required
string | null
<= 256 characters /^[A-Za-z0-9_-]+$/
state
required
string
Allowed values: delivering failed retrying skipped succeeded
updatedAt
required
string format: date-time
webhookId
required
string
>= 1 characters <= 256 characters /^[A-Za-z0-9_-]+$/
id
required
string
>= 1 characters <= 256 characters /^[A-Za-z0-9_-]+$/
type
required
string
Allowed value: webhookDelivery
meta
required
object
requestId
required
string
Example
{
  "data": {
    "attributes": {
      "attempts": [
        {
          "errorCode": "http_error",
          "state": "delivering"
        }
      ],
      "state": "delivering"
    },
    "type": "webhookDelivery"
  }
}

400

Section titled “400”

The request is invalid.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

Section titled “401”

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

Section titled “403”

The credential has insufficient scope.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

404

Section titled “404”

The tenant-scoped resource does not exist.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

Section titled “429”

The credential or source exceeded its rate limit.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

Headers

Section titled “Headers”
Retry-After
integer
>= 1

Minimum delay in seconds before retrying.

X-RateLimit-Limit
integer

Maximum requests in the current window.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix time in milliseconds when the current window resets.

X-Request-Id
string

Request correlation identifier.

502

Section titled “502”

The cell-local application returned an invalid response.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

503

Section titled “503”

A required cell-local dependency is unavailable.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}