registerDeliveryPartnerWebhook

Requires permission settings:integration:update.

Registers this organization's webhook URL through the delivery provider's own API. A provider without such an API is refused, with a note that its webhook is set up in its own dashboard. Needs the delivery partners plan feature and permission to update integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RegisterDeliveryPartnerWebhook($id: ID!) {
  registerDeliveryPartnerWebhook(id: $id) {
    keysCheckDetail
    keysCheckedAt
    keysValid
    needsReverification
    webhookReachable
    webhookRegisteredAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RegisterDeliveryPartnerWebhook($id: ID!) {\n  registerDeliveryPartnerWebhook(id: $id) {\n    keysCheckDetail\n    keysCheckedAt\n    keysValid\n    needsReverification\n    webhookReachable\n    webhookRegisteredAt\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "registerDeliveryPartnerWebhook": {
      "keysCheckDetail": "string",
      "keysCheckedAt": "string",
      "keysValid": true,
      "needsReverification": true,
      "webhookReachable": true,
      "webhookRegisteredAt": "string"
    }
  }
}

registerDeliveryPartnerWebhook(
  id: ID!
): DeliveryPartnerVerification!

Arguments

registerDeliveryPartnerWebhook.id ● ID! non-null scalar

The ID of the delivery partner configuration.

Type

DeliveryPartnerVerification object

The result of checking a delivery partner's credentials and webhook.