Skip to main content

ProviderDeactivatedEventData

This is an object representing data for the provider deactivated event.

object objectrequired

A provider represents a staff member who can provide services to clients.

created_atstring<date-time>required

Time at which the object was created.

display_namestringrequired

The provider's display name.

first_namestringrequired

The provider's first name.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^prov_\w{12}$

last_namestringrequired

The provider's last name.

metadata object

Set of key-value pairs attached to this provider. Maximum size is 16 KB.

property name*any

Set of key-value pairs attached to this provider. Maximum size is 16 KB.

objectstringrequired

String representing the object's type.

Possible values: [provider]

updated_atstring<date-time>required

Time at which the object was last updated.

typestringrequired

The event type.

Possible values: [provider.deactivated]

ProviderDeactivatedEventData
{
"object": {
"created_at": "2017-09-12T12:34:55Z",
"display_name": "John Smith",
"first_name": "John",
"id": "prov_d025a96ac0c6",
"last_name": "Smith",
"metadata": {
"external_id": "123"
},
"object": "provider",
"updated_at": "2017-09-13T10:11:12Z"
},
"type": "provider.deactivated"
}