Call information

Sectigo will call the URL you provide.

HTTP methods and event types

  • For most event types, Sectigo uses a GET request to your URL when only status information is sent.

  • If certificate delivery is enabled, Sectigo uses a POST request and includes the certificate and chain.

  • For the PreRevocationNotification event type, a POST request is always used.

Parameters for all event types (except PreRevocationNotification)

Without certificate push

These parameters will be passed via an HTTP(S) GET request to your URL as follows:

Parameter Type Description

orderNumber

string

Sectigo order number.

certificateID

integer

Sectigo certificate ID.

eventType

string

The type of push notification.

With certificate push

The preceding parameters are sent, with two additions. All parameters are sent to your URL in an HTTP(S) POST request.

Parameter Type Description

certificate

string

A certificate encoded in PEM format (Base64 with PEM headers).

caCertificate

string

PEM-encoded certificate chain.

Additional parameters for Certificate event type

Parameter Type Description

status

string

The certificate status.

statusCode

integer

Certificate status as an integer value. For more information, see Status codes.

statusDesc

string

The brief description of the status.

removedDomains

string

Removed domains from the certificate (issued status only).

revocationReasonCode

integer

CRL reason codes for end-entity TLS certificates.

revocationReasonName

string

CRL reason name.

bimi-l

string

Logo URL for BIMI DNS record creation. This parameter is only relevant for issued mark certificate products when using the CA-hosted mode.

bimi-a

string

The URL of the certificate PEM file for BIMI DNS record creation. This is relevant for issued mark certificate products when the CA-hosted mode is selected.

Additional parameters for CallBack event type

Parameter Type Description

status

string

The certificate status.

statusCode

integer

The certificate status as an integer value. For more information, see Status codes.

statusDesc

string

The brief description of the status.

verificationCode

string

Verification code for callback confirmation.

Additional parameters for Agreement event type

Parameter Type Description

status

string

The certificate status.

statusCode

integer

Certificate status as an integer value. For more information, see Status codes.

statusDesc

string

The brief description of the status.

verificationCode

string

Verification code for click-through agreement confirmation.

Additional parameters for MasterAccount event type

Parameter Type Description

maStatus

string

The status of the organization pre-validation sign up (such as, master account).

maStatusDesc

string

The brief description of the organization pre-validation status.

maCreationDate

string

Organization pre-validation creation date (dd-mm-yyyy).

maExpirationDate

string

Organization pre-validation expiration date (dd-mm-yyyy).

Additional parameters for SiteLockFreemium event type

Parameter Type Description

status

string

The status of synchronization with the SiteLock platform.

synced

string

The status description.

siteLockUserID

integer

SiteLock user ID.

siteLockSiteIDs

string

SiteLock site IDs.

Parameters for PreRevocationNotification event type

The following parameters will always be passed as an HTTP(S) POST request to your URL.

Parameter Type Description

eventType

string

The type of push notification.

revocationReasonCode

integer

CRL reason codes for end-entity TLS сertificates.

revocationReasonName

string

CRL revocation reason name.

preRevocationEmailSubject

string

Pre-revocation email subject (Base64-encoded value).

preRevocationEmailBody

string

Pre-revocation email body (Base64-encoded value).

serialNumberList

string

Certificate serial numbers list, separated by semicolons ; .

productTypeNameList

string

Product type names list, separated by semicolons ;.

Other optional parameters

Parameter Type Description

foreignOrderNumber

string

An external order identifier provided when placing the order, used to track and correlate the order across API responses and notifications.

acmeAccountID

string

ACME account identifier.

acmeOrderID

string

ACME order identifier.

acmeEABKeyID

string

ACME External Account Binding (EAB) Key ID.

acmeReplacesOrderNumber

string

The order number of the certificate that this certificate replaces (if known).