callback

Creates, updates, deletes, gets or lists a callback resource.

Overview

Name	callback
Type	Resource
Id	godaddy.certificates.callback

Fields

The following fields are returned by SELECT queries:

certificate_callback_get

Callback registered

Name	Datatype	Description
callbackUrl	string	Callback url registered to receive stateful actions

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
certificate_callback_get	select	certificate_id		This method is used to retrieve the registered callback url for a certificate.
certificate_callback_delete	delete	certificate_id		Unregister the callback for a particular certificate.
certificate_callback_replace	exec	certificate_id, callbackUrl		This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
callbackUrl	string	Callback url registered/replaced to receive stateful actions
certificate_id	string	Certificate id to register/replace for callback

SELECT examples

certificate_callback_get

This method is used to retrieve the registered callback url for a certificate.

SELECT
callbackUrl
FROM godaddy.certificates.callback
WHERE certificate_id = '{{ certificate_id }}' -- required
;

DELETE examples

certificate_callback_delete

Unregister the callback for a particular certificate.

DELETE FROM godaddy.certificates.callback
WHERE certificate_id = '{{ certificate_id }}' --required
;

Lifecycle Methods

certificate_callback_replace

This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration.

EXEC godaddy.certificates.callback.certificate_callback_replace 
@certificate_id='{{ certificate_id }}' --required, 
@callbackUrl='{{ callbackUrl }}' --required
;