logo

Application instance was enabledWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Application instance enabled webhook request body resource.

organizationId
string (OrganizationId) <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

applicationId
string <= 50 characters

Unique application ID.

eventType
string

Type of webhook event.

Value: "application-instance-enabled"
object

Embedded objects.

object (Application)

Application object.

name
required
string

Name of the application.

logoId
required
string <= 50 characters

File ID of the application logo.

authorName
required
string

Name of the application author.

tagline
required
string

Tagline of the application.

description
required
string

Detailed application description. This field accepts markdown and simple text.

permissions
required
Array of strings <operationId>

List of permissions that are available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
id
string <= 50 characters

ID of the application.

authorLogoId
string <= 50 characters

File ID of the author's logo.

status
string

Status of the application.

Enum: "pending-approval" "available" "disabled"
properties
object

Defines settings that users can complete when they install the application. This field accepts JSON-schema drafts 4, 6, and 7.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

object (OwnerApplicationInstance)

Application instance object.

required
object

Settings that are available for the user to complete when they install the application. Use this object to describe fields that are rendered during installation, in the settings form.

status
string

Status of the application instance.

Enum: "enabling" "enabled" "disabling" "disabled"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

token
string

Session token used to authenticate an organization.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "application" "applicationInstance"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "applicationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventType": "application-instance-enabled",
  • "_embedded": {
    },
  • "_links": [
    ]
}
➔ Next to Application users