Skip to main content

DeliveryPartnerVerification

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

type DeliveryPartnerVerification {
  keysCheckDetail: String
  keysCheckedAt: String
  keysValid: Boolean!
  needsReverification: Boolean!
  webhookReachable: Boolean!
  webhookRegisteredAt: String
}

Fields​

DeliveryPartnerVerification.keysCheckDetail ● String scalar​

Detail from the credential check, such as why it failed.

DeliveryPartnerVerification.keysCheckedAt ● String scalar​

When the credentials were last checked.

DeliveryPartnerVerification.keysValid ● Boolean! non-null scalar​

True when the saved credentials were accepted by the provider.

DeliveryPartnerVerification.needsReverification ● Boolean! non-null scalar​

True when a credential edit disabled the partner. Verify it again, then enable it.

DeliveryPartnerVerification.webhookReachable ● Boolean! non-null scalar​

True when the provider's webhook reached the API.

DeliveryPartnerVerification.webhookRegisteredAt ● String scalar​

When the webhook was registered with the provider.

Returned By​

registerDeliveryPartnerWebhook mutation ● testDeliveryPartnerConnection mutation

Member Of​

DeliveryPartnerConfigGql object